{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2026. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v2.2.0"},"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"}}}}},"/obp/v1.2.1/banks":{"get":{"tags":["Bank","PSD2","Old-Style"],"summary":"Get Banks","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get banks on this API instance
Returns a list of banks supported on this server:

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

JSON response body fields:

address:

bank_routing:

banks:

full_name: full name string

id: d8839721-ad8f-45dd-9f78-2080414b93f9

logo: logo url

scheme: OBP

short_name:

website: www.openbankproject.com

","operationId":"OBPv1.2.1-getBanks","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BanksJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v1.2.1/banks/{BANK_ID}":{"get":{"tags":["Bank","PSD2","Old-Style"],"summary":"Get Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get the bank specified by BANK_ID
Returns information about a single bank specified by BANK_ID including:

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

address:

bank_routing:

full_name: full name string

id: d8839721-ad8f-45dd-9f78-2080414b93f9

logo: logo url

scheme: OBP

short_name:

website: www.openbankproject.com

","operationId":"OBPv1.2.1-bankById","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BankJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}":{"post":{"tags":["Account"],"summary":"Update Account Label","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account'

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

BANK_ID: gh.29.uk

JSON request body fields:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateAccountLabel","parameters":[{"in":"body","name":"body","description":"UpdateAccountJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/UpdateAccountJSON"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts":{"get":{"tags":["Counterparty","Account","PSD2","Old-Style"],"summary":"Get Other Accounts of one Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID.
User Authentication is Optional. The User need not be logged in.
Authentication is required if the view VIEW_ID is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

IBAN: DE91 1000 0000 0123 4567 89

URL: http://www.example.com/id-docs/123/image.png

bank:

corporate_location: 10

date: 2020-01-27

display_name:

holder:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

is_alias:

kind:

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

national_identifier:

number:

open_corporates_URL:

other_accounts:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

swift_bic:

user:

","operationId":"OBPv1.2.1-getOtherAccountsForBankAccount","parameters":[{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OtherAccountsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}":{"get":{"tags":["Counterparty","Account"],"summary":"Get Other Account by Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID.
User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

IBAN: DE91 1000 0000 0123 4567 89

URL: http://www.example.com/id-docs/123/image.png

bank:

corporate_location: 10

date: 2020-01-27

display_name:

holder:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

is_alias:

kind:

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

national_identifier:

number:

open_corporates_URL:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

swift_bic:

user:

","operationId":"OBPv1.2.1-getOtherAccountByIdForBankAccount","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OtherAccountJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata":{"get":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Get Other Account Metadata","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get metadata of one other account.
Returns only the metadata about one other bank account (OTHER_ACCOUNT_ID) that had shared at least one transaction with ACCOUNT_ID at BANK_ID.

Authentication via OAuth is required if the view is not public.

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

URL: http://www.example.com/id-docs/123/image.png

corporate_location: 10

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

latitude: 38.8951

longitude: -77.0364

more_info: More information about this fee

open_corporates_URL:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

user:

","operationId":"OBPv1.2.1-getOtherAccountMetadata","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OtherAccountMetadataJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/corporate_location":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Corporate Location","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete corporate location of other bank account. Delete the geolocation of the counterparty's registered address

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyCorporateLocation","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add Corporate Location to Counterparty","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Add the geolocation of the counterparty's registered address

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

corporate_location: 10

latitude: 38.8951

longitude: -77.0364

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addCounterpartyCorporateLocation","parameters":[{"in":"body","name":"body","description":"CorporateLocationJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CorporateLocationJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty Corporate Location","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update the geolocation of the counterparty's registered address

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyCorporateLocation","parameters":[{"in":"body","name":"body","description":"CorporateLocationJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CorporateLocationJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/image_url":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Image URL","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete image url of other bank account

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

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyImageUrl","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add image url to other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Add a url that points to the logo of the counterparty

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

image_URL:

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addCounterpartyImageUrl","parameters":[{"in":"body","name":"body","description":"ImageUrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ImageUrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty Image Url","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update the url that points to the logo of the counterparty

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

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyImageUrl","parameters":[{"in":"body","name":"body","description":"ImageUrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ImageUrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/more_info":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete more info of other bank account","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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyMoreInfo","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add Counterparty More Info","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Add a description of the counter party from the perpestive of the account e.g. My dentist

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

more_info: More information about this fee

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addCounterpartyMoreInfo","parameters":[{"in":"body","name":"body","description":"MoreInfoJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/MoreInfoJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty More Info","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update the more info description of the counter party from the perpestive of the account e.g. My dentist

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyMoreInfo","parameters":[{"in":"body","name":"body","description":"MoreInfoJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/MoreInfoJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/open_corporates_url":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Open Corporates URL","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete open corporate url of other bank account

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyOpenCorporatesUrl","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add Open Corporates URL to Counterparty","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Add open corporates url to other bank account

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

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

open_corporates_URL:

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addCounterpartyOpenCorporatesUrl","parameters":[{"in":"body","name":"body","description":"OpenCorporateUrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/OpenCorporateUrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Open Corporates Url of Counterparty","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update open corporate url of other bank account

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyOpenCorporatesUrl","parameters":[{"in":"body","name":"body","description":"OpenCorporateUrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/OpenCorporateUrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/physical_location":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Physical Location","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete physical location of other bank account

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyPhysicalLocation","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add physical location to other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Add geocoordinates of the counterparty's main location

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

latitude: 38.8951

longitude: -77.0364

physical_location:

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addCounterpartyPhysicalLocation","parameters":[{"in":"body","name":"body","description":"PhysicalLocationJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PhysicalLocationJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty Physical Location","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update geocoordinates of the counterparty's main location

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyPhysicalLocation","parameters":[{"in":"body","name":"body","description":"PhysicalLocationJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PhysicalLocationJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/url":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete url of other bank account","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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyUrl","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add url to other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

A url which represents the counterparty (home page url etc.)

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

URL: http://www.example.com/id-docs/123/image.png

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addCounterpartyUrl","parameters":[{"in":"body","name":"body","description":"UrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/UrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update url of other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

A url which represents the counterparty (home page url etc.)

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyUrl","parameters":[{"in":"body","name":"body","description":"UrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/UrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/private_alias":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Private Alias","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Deletes the private alias of the other account OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyPrivateAlias","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"get":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Get Other Account Private Alias","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the private alias of the other account OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

alias:

","operationId":"OBPv1.2.1-getOtherAccountPrivateAlias","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AliasJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Create Other Account Private Alias","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Creates a private alias for the other account OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

alias:

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addOtherAccountPrivateAlias","parameters":[{"in":"body","name":"body","description":"AliasJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AliasJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty Private Alias","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Updates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyPrivateAlias","parameters":[{"in":"body","name":"body","description":"AliasJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AliasJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/public_alias":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Public Alias","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Deletes the public alias of the other account OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyPublicAlias","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"get":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Get public alias of other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the public alias of the other account OTHER_ACCOUNT_ID.
User Authentication is Optional. The User need not be logged in.
User Authentication is Required. The User must be logged in. The Application must also be authenticated. if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

alias:

","operationId":"OBPv1.2.1-getCounterpartyPublicAlias","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AliasJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add public alias to other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Creates the public alias for the other account OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

Note: Public aliases are automatically generated for new 'other accounts / counterparties', so this call should only be used if
the public alias was deleted.

The VIEW_ID parameter should be a view the caller is permitted to access to and that has permission to create public aliases.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

alias:

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addCounterpartyPublicAlias","parameters":[{"in":"body","name":"body","description":"AliasJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AliasJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update public alias of other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyPublicAlias","parameters":[{"in":"body","name":"body","description":"AliasJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AliasJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions":{"get":{"tags":["Transaction","Account","PSD2","Old-Style"],"summary":"Get Transactions for Account (Full)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID).

Authentication via OAuth is required if the view is not public.

Possible custom url parameters for pagination:

eg1:?limit=100&offset=0

eg2:?limit=100&offset=0&sort_direction=ASC

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z

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

URL Parameters:

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

IBAN: DE91 1000 0000 0123 4567 89

URL: http://www.example.com/id-docs/123/image.png

amount: 10.12

bank:

comments:

completed: 2020-01-27

corporate_location: 10

currency: EUR

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

display_name:

holder:

holders:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

images:

is_alias:

kind:

label: My Account

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

narrative:

national_identifier:

new_balance: 20

number:

open_corporates_URL:

other_account:

physical_location:

posted: 2020-01-27

private_alias:

provider: ETHEREUM

public_alias:

swift_bic:

tags: Create-My-User

this_account:

transactions:

type:

user:

value: 5987953

where:

","operationId":"OBPv1.2.1-getTransactionsForBankAccount","parameters":[{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/comments":{"get":{"tags":["Transaction-Metadata","Transaction"],"summary":"Get Transaction Comments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the transaction TRANSACTION_ID comments made on a view (VIEW_ID).

Authentication via OAuth is required if the view is not public.

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

comments:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

provider: ETHEREUM

user:

value: 5987953

","operationId":"OBPv1.2.1-getCommentsForViewOnTransaction","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionCommentsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Transaction-Metadata","Transaction"],"summary":"Add a Transaction Comment","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Posts a comment about a transaction TRANSACTION_ID on a view VIEW_ID.

${authenticationRequiredMessage(false)}

Authentication is required since the comment is linked with the user.

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON request body fields:

value: 5987953

JSON response body fields:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

provider: ETHEREUM

user:

value: 5987953

","operationId":"OBPv1.2.1-addCommentForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"PostTransactionCommentJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionCommentJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionCommentJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/comments/{COMMENT_ID}":{"delete":{"tags":["Transaction-Metadata","Transaction"],"summary":"Delete a Transaction Comment","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on view.

Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.

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

BANK_ID: gh.29.uk

COMMENT_ID:

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCommentForViewOnTransaction","parameters":[{"in":"path","name":"COMMENT_ID","description":"The comment id","required":true,"type":"string"},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/images":{"get":{"tags":["Transaction-Metadata","Transaction"],"summary":"Get Transaction Images","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the transaction TRANSACTION_ID images made on a view (VIEW_ID).
Authentication via OAuth is required if the view is not public.

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

URL: http://www.example.com/id-docs/123/image.png

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

images:

label: My Account

provider: ETHEREUM

user:

","operationId":"OBPv1.2.1-getImagesForViewOnTransaction","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionImagesJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Transaction-Metadata","Transaction"],"summary":"Add a Transaction Image","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Posts an image about a transaction TRANSACTION_ID on a view VIEW_ID.

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

The image is linked with the user.

URL Parameters:

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON request body fields:

URL: http://www.example.com/id-docs/123/image.png

label: My Account

JSON response body fields:

URL: http://www.example.com/id-docs/123/image.png

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

provider: ETHEREUM

user:

","operationId":"OBPv1.2.1-addImageForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"PostTransactionImageJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionImageJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionImageJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/images/{IMAGE_ID}":{"delete":{"tags":["Transaction-Metadata","Transaction"],"summary":"Delete a Transaction Image","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Deletes the image IMAGE_ID about the transaction TRANSACTION_ID made on view.

Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.

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

BANK_ID: gh.29.uk

IMAGE_ID:

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteImageForViewOnTransaction","parameters":[{"in":"path","name":"IMAGE_ID","description":"The image id","required":true,"type":"string"},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/narrative":{"delete":{"tags":["Transaction-Metadata","Transaction"],"summary":"Delete a Transaction Narrative","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Deletes the description of the transaction TRANSACTION_ID.

Authentication via OAuth is required if the view is not public.

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteTransactionNarrative","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["Transaction-Metadata","Transaction"],"summary":"Get a Transaction Narrative","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the account owner description of the transaction moderated by the view.

Authentication via OAuth is required if the view is not public.

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

URL Parameters:

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

narrative:

","operationId":"OBPv1.2.1-getTransactionNarrative","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionNarrativeJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"post":{"tags":["Transaction-Metadata","Transaction"],"summary":"Add a Transaction Narrative","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Creates a description of the transaction TRANSACTION_ID.

Note: Unlike other items of metadata, there is only one "narrative" per transaction accross all views.
If you set narrative via a view e.g. view-x it will be seen via view-y (as long as view-y has permission to see the narrative).

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON request body fields:

narrative:

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addTransactionNarrative","parameters":[{"in":"body","name":"body","description":"TransactionNarrativeJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionNarrativeJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}},"put":{"tags":["Transaction-Metadata","Transaction"],"summary":"Update a Transaction Narrative","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Updates the description of the transaction TRANSACTION_ID.

Authentication via OAuth is required if the view is not public.

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

URL Parameters:

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateTransactionNarrative","parameters":[{"in":"body","name":"body","description":"TransactionNarrativeJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionNarrativeJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/tags":{"get":{"tags":["Transaction-Metadata","Transaction"],"summary":"Get Transaction Tags","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the transaction TRANSACTION_ID tags made on a view (VIEW_ID).
Authentication via OAuth is required if the view is not public.

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

URL Parameters:

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

provider: ETHEREUM

user:

value: 5987953

","operationId":"OBPv1.2.1-getTagsForViewOnTransaction","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionTagJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"post":{"tags":["Transaction-Metadata","Transaction"],"summary":"Add a Transaction Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Posts a tag about a transaction TRANSACTION_ID on a view VIEW_ID.

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

Authentication is required as the tag is linked with the user.

URL Parameters:

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON request body fields:

value: 5987953

JSON response body fields:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

provider: ETHEREUM

user:

value: 5987953

","operationId":"OBPv1.2.1-addTagForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"PostTransactionTagJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionTagJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionTagJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/tags/{TAG_ID}":{"delete":{"tags":["Transaction-Metadata","Transaction"],"summary":"Delete a Transaction Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on view.
Authentication via OAuth is required. The user must either have owner privileges for this account,
or must be the user that posted the tag.

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

URL Parameters:

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

BANK_ID: gh.29.uk

TAG_ID:

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteTagForViewOnTransaction","parameters":[{"in":"path","name":"TAG_ID","description":"The tag id","required":true,"type":"string"},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorNoViewPermission"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/where":{"delete":{"tags":["Transaction-Metadata","Transaction"],"summary":"Delete a Transaction Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Deletes the where tag of the transaction TRANSACTION_ID made on view.

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

The user must either have owner privileges for this account, or must be the user that posted the geo tag.

URL Parameters:

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteWhereTagForViewOnTransaction","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["Transaction-Metadata","Transaction"],"summary":"Get a Transaction where Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the "where" Geo tag added to the transaction TRANSACTION_ID made on a view (VIEW_ID).
It represents the location where the transaction has been initiated.

Authentication via OAuth is required if the view is not public.

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

URL Parameters:

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

longitude: -77.0364

provider: ETHEREUM

user:

where:

","operationId":"OBPv1.2.1-getWhereTagForViewOnTransaction","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionWhereJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"post":{"tags":["Transaction-Metadata","Transaction"],"summary":"Add a Transaction where Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Creates a "where" Geo tag on a transaction TRANSACTION_ID in a view.

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

The geo tag is linked with the user.

URL Parameters:

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON request body fields:

latitude: 38.8951

longitude: -77.0364

where:

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addWhereTagForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"PostTransactionWhereJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionWhereJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Transaction-Metadata","Transaction"],"summary":"Update a Transaction where Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Updates the "where" Geo tag on a transaction TRANSACTION_ID in a view.

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

The geo tag is linked with the user.

URL Parameters:

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateWhereTagForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"PostTransactionWhereJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionWhereJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/other_account":{"get":{"tags":["Transaction","Counterparty"],"summary":"Get Other Account of Transaction","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get other account of a transaction.
Returns details of the other party involved in the transaction, moderated by the view (VIEW_ID).
Authentication via OAuth is required if the view is not public.

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

URL Parameters:

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

IBAN: DE91 1000 0000 0123 4567 89

URL: http://www.example.com/id-docs/123/image.png

bank:

corporate_location: 10

date: 2020-01-27

display_name:

holder:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

is_alias:

kind:

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

national_identifier:

number:

open_corporates_URL:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

swift_bic:

user:

","operationId":"OBPv1.2.1-getOtherAccountForTransaction","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OtherAccountJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/transaction":{"get":{"tags":["Transaction","PSD2","Old-Style"],"summary":"Get Transaction by Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and moderated by the view (VIEW_ID).

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

IBAN: DE91 1000 0000 0123 4567 89

URL: http://www.example.com/id-docs/123/image.png

amount: 10.12

bank:

comments:

completed: 2020-01-27

corporate_location: 10

currency: EUR

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

display_name:

holder:

holders:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

images:

is_alias:

kind:

label: My Account

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

narrative:

national_identifier:

new_balance: 20

number:

open_corporates_URL:

other_account:

physical_location:

posted: 2020-01-27

private_alias:

provider: ETHEREUM

public_alias:

swift_bic:

tags: Create-My-User

this_account:

type:

user:

value: 5987953

where:

","operationId":"OBPv1.2.1-getTransactionByIdForBankAccount","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/permissions/{PROVIDER}/{PROVIDER_ID}/views":{"delete":{"tags":["View-Custom","Account","User","OwnerViewRequired"],"summary":"Revoke access to all Views on Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

"Revokes access to all Views on an Account for a certain User.

The User is identified by PROVIDER_ID at their PROVIDER.

The Account is specified by BANK_ID and ACCOUNT_ID.

The View is specified by VIEW_ID.

PROVIDER (may be a URL so) must be URL Encoded.

PROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.

Attempting to revoke access to a public view will return an error message.

An Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.

URL Parameters:

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

BANK_ID: gh.29.uk

PROVIDER: ETHEREUM

PROVIDER_ID:

JSON response body fields:

","operationId":"OBPv1.2.1-removePermissionForUserForBankAccountForAllViews","parameters":[{"in":"path","name":"PROVIDER","description":"the user PROVIDER","required":true,"type":"string"},{"in":"path","name":"PROVIDER_ID","description":"The provider id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["View-Custom","Account","User","OwnerViewRequired"],"summary":"Grant User access to a list of views","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Grants the user identified by PROVIDER_ID at their provider PROVIDER access to a list of views at BANK_ID for account ACCOUNT_ID.

All url parameters must be %-encoded, which is often especially relevant for PROVIDER_ID and PROVIDER.

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

The User needs to have access to the owner view.

URL Parameters:

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

BANK_ID: gh.29.uk

PROVIDER: ETHEREUM

PROVIDER_ID:

JSON request body fields:

views:

JSON response body fields:

alias:

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

short_name:

views:

","operationId":"OBPv1.2.1-addPermissionForUserForBankAccountForMultipleViews","parameters":[{"in":"body","name":"body","description":"ViewIdsJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ViewIdsJson"}},{"in":"path","name":"PROVIDER","description":"the user PROVIDER","required":true,"type":"string"},{"in":"path","name":"PROVIDER_ID","description":"The provider id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/ViewsJSONV121"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/permissions/{PROVIDER}/{PROVIDER_ID}/views/{VIEW_ID}":{"delete":{"tags":["View-Custom","Account","User","Entitlement","OwnerViewRequired"],"summary":"Revoke access to one View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Revokes access to a View on an Account for a certain User.

The User is identified by PROVIDER_ID at their PROVIDER.

The Account is specified by BANK_ID and ACCOUNT_ID.

The View is specified by VIEW_ID.

PROVIDER (may be a URL so) must be URL Encoded.

PROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.

Attempting to revoke access to a public view will return an error message.

An Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.

URL Parameters:

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

BANK_ID: gh.29.uk

PROVIDER: ETHEREUM

PROVIDER_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-removePermissionForUserForBankAccountForOneView","parameters":[{"in":"path","name":"PROVIDER","description":"the user PROVIDER","required":true,"type":"string"},{"in":"path","name":"PROVIDER_ID","description":"The provider id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["View-Custom","Account","User","OwnerViewRequired"],"summary":"Grant User access to View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Grants the User identified by PROVIDER_ID at PROVIDER access to the view VIEW_ID at BANK_ID for account ACCOUNT_ID.

All url parameters must be %-encoded, which is often especially relevant for PROVIDER and PROVIDER_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.

Granting access to a public view will return an error message, as the user already has access.

URL Parameters:

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

BANK_ID: gh.29.uk

PROVIDER: ETHEREUM

PROVIDER_ID:

VIEW_ID: owner

JSON request body fields:

JSON response body fields:

alias:

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

short_name:

","operationId":"OBPv1.2.1-addPermissionForUserForBankAccountForOneView","parameters":[{"in":"path","name":"PROVIDER","description":"the user PROVIDER","required":true,"type":"string"},{"in":"path","name":"PROVIDER_ID","description":"The provider id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/ViewJSONV121"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/views/{VIEW_ID}":{"delete":{"tags":["View-Custom","Account"],"summary":"Delete Custom View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Deletes the custom view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteViewForBankAccount","parameters":[{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.2.1/banks/{BANK_ID}/resource-docs/{API_VERSION}/obp":{"get":{"tags":["Documentation","API"],"summary":"Get Bank Level Dynamic Resource Docs","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.

This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.

This endpoint is used by OBP API Explorer to display and work with the API documentation.

Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank

You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics

For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.

You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.

You may need some other language resource docs, now we support en_GB and es_ES at the moment.

You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.

See the Resource Doc endpoint for more information.

Note: Dynamic Resource Docs are cached, TTL is 3600 seconds
Static Resource Docs are cached, TTL is 3600 seconds

Following are more examples:
https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp
https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?tags=Account,Bank
https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?functions=getBanks,bankById
https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=es_ES
https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221

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

URL Parameters:

API_VERSION:

BANK_ID: gh.29.uk

JSON response body fields:

","operationId":"OBPv1.4.0-getBankLevelDynamicResourceDocsObp","parameters":[{"in":"path","name":"API_VERSION","description":"eg:v2.2.0, v3.0.0","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v1.2.1/resource-docs/{API_VERSION}/obp":{"get":{"tags":["Documentation","API"],"summary":"Get Resource Docs","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.

This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.

This endpoint is used by OBP API Explorer to display and work with the API documentation.

Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank

You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics

For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.

You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.

You may need some other language resource docs, now we support en_GB and es_ES at the moment.

You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.

See the Resource Doc endpoint for more information.

Note: Dynamic Resource Docs are cached, TTL is 3600 seconds
Static Resource Docs are cached, TTL is 3600 seconds

Following are more examples:
https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp
https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank
https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById
https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=es_ES
https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221

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

URL Parameters:

API_VERSION:

JSON response body fields:

","operationId":"OBPv1.4.0-getResourceDocsObp","parameters":[{"in":"path","name":"API_VERSION","description":"eg:v2.2.0, v3.0.0","required":true,"type":"string"}],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v1.2.1/resource-docs/{API_VERSION}/openapi":{"get":{"tags":["Documentation","API"],"summary":"Get OpenAPI 3.1 documentation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns documentation about the RESTful resources on this server in OpenAPI 3.1 format.

API_VERSION is the version you want documentation about e.g. v6.0.0

Query Parameters

You may filter this endpoint using the following optional query parameters:

tags - Filter by endpoint tags (comma-separated list)
• Example: ?tags=Account,Bank or ?tags=Account-Firehose
• All endpoints are given one or more tags which are used for grouping
• Empty values will return error OBP-10053

functions - Filter by function names (comma-separated list)
• Example: ?functions=getBanks,bankById
• Each endpoint is implemented in the OBP Scala code by a 'function'
• Empty values will return error OBP-10054

content - Filter by endpoint type
• Values: static, dynamic, all (case-insensitive)
• static: Only show static/core API endpoints
• dynamic: Only show dynamic/custom endpoints
• all: Show both static and dynamic endpoints (default)
• Invalid values will return error OBP-10052

locale - Language for localized documentation
• Example: ?locale=en_GB or ?locale=es_ES
• Supported locales: en_GB, es_ES, ro_RO
• Invalid locales will return error OBP-10041

api-collection-id - Filter by API collection UUID
• Example: ?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
• Returns only endpoints belonging to the specified collection
• Empty values will return error OBP-10055

This endpoint generates OpenAPI 3.1 compliant documentation with modern JSON Schema support.

For YAML format, use the corresponding endpoint: /resource-docs/API_VERSION/openapi.yaml

See the Resource Doc endpoint for more information.

Note: Resource Docs are cached, TTL is 3600 seconds

Examples

Basic usage:
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi

Filter by tags:
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account,Bank
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account-Firehose

Filter by content type:
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=dynamic

Filter by functions:
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?functions=getBanks,bankById

Combine multiple parameters:
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static&tags=Account-Firehose
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account,Bank,PSD2&functions=getBanks,bankById
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static&locale=en_GB&tags=Account

Filter by API collection:
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221

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

URL Parameters:

API_VERSION:

JSON response body fields:

","operationId":"OBPv1.4.0-getResourceDocsOpenAPI31","parameters":[{"in":"path","name":"API_VERSION","description":"eg:v2.2.0, v3.0.0","required":true,"type":"string"}],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidApiVersionString"}}}}},"/obp/v1.2.1/resource-docs/{API_VERSION}/swagger":{"get":{"tags":["Documentation","API"],"summary":"Get Swagger documentation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns documentation about the RESTful resources on this server in Swagger format.

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank

(All endpoints are given one or more tags which for used in grouping)

You may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById

(Each endpoint is implemented in the OBP Scala code by a 'function')

See the Resource Doc endpoint for more information.

Note: Resource Docs are cached, TTL is 3600 seconds

Following are more examples:
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById

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

URL Parameters:

API_VERSION:

JSON response body fields:

","operationId":"OBPv1.4.0-getResourceDocsSwagger","parameters":[{"in":"path","name":"API_VERSION","description":"eg:v2.2.0, v3.0.0","required":true,"type":"string"}],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v2.2.0/accounts":{"get":{"tags":["Account","PrivateData","PublicData","Old-Style"],"summary":"Get all Accounts at all Banks","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get all accounts at all banks the User has access to.
Returns the list of accounts at that the user has access to at all banks.
For each account the API returns the account ID and the available views.

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

JSON response body fields:

accounts:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

short_name:

views_available:

","operationId":"OBPv2.0.0-getPrivateAccountsAllBanks","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BasicAccountsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/accounts/public":{"get":{"tags":["Account-Public","Account","PublicData"],"summary":"Get Public Accounts at all Banks","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get public accounts at all banks (Anonymous access).
Returns accounts that contain at least one public view (a view where is_public is true)
For each account the API returns the ID and the available views.

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

JSON response body fields:

accounts:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

short_name:

views_available:

","operationId":"OBPv2.0.0-publicAccountsAllBanks","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BasicAccountsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorCannotGetAccounts"}}}}},"/obp/v2.2.0/banks":{"post":{"tags":["Bank","Old-Style"],"summary":"Create Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create a new bank (Authenticated access).
User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

address:

bank_routing:

full_name: full name string

id: d8839721-ad8f-45dd-9f78-2080414b93f9

logo_url: logo_url

national_identifier:

scheme: OBP

short_name:

swift_bic:

website_url: website_url

JSON response body fields:

address:

bank_routing:

full_name: full name string

id: d8839721-ad8f-45dd-9f78-2080414b93f9

logo_url: logo_url

national_identifier:

scheme: OBP

short_name:

swift_bic:

website_url: website_url

","operationId":"OBPv2.2.0-createBank","parameters":[{"in":"body","name":"body","description":"BankJSONV220 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/BankJSONV220"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/BankJSONV220"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts":{"get":{"tags":["Account","PrivateData","PublicData"],"summary":"Get Accounts at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the list of accounts at BANK_ID that the user has access to.
For each account the API returns the account ID and the views available to the user..
Each account must have at least one private View.

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

accounts:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

short_name:

views_available:

","operationId":"OBPv2.0.0-getPrivateAccountsAtOneBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BasicAccountsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}":{"put":{"tags":["Account","Onboarding"],"summary":"Create Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.

The User can create an Account for themself or an Account for another User if they have CanCreateAccount role.

If USER_ID is not specified the account will be owned by the logged in User.

The type field should be a product_code from Product.

Note: The Amount must be zero.

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

BANK_ID: gh.29.uk

JSON response body fields:

account_routing:

address:

amount: 10.12

balance: 10

branch_id: DERBY6

currency: EUR

label: My Account

scheme: OBP

type:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

","operationId":"OBPv2.2.0-createAccount","parameters":[{"in":"body","name":"body","description":"CreateAccountJSONV220 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateAccountJSONV220"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CreateAccountJSONV220"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/account":{"get":{"tags":["Account","Old-Style"],"summary":"Get Account by Id (Full)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Information returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):

More details about the data moderation by the view here.

PSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
This call provides balance and other account information via delegated authentication using OAuth.

User Authentication is Required. The User must be logged in. The Application must also be authenticated. if the 'is_public' field in view (VIEW_ID) is not set to true.

URL Parameters:

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

IBAN: DE91 1000 0000 0123 4567 89

account_routing:

address:

alias:

amount: 10.12

balance: 10

bank_id: gh.29.uk

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

display_name:

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

number:

owners:

provider: ETHEREUM

scheme: OBP

short_name:

swift_bic:

type:

views_available:

","operationId":"OBPv2.0.0-accountById","parameters":[{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ModeratedAccountJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/counterparties":{"get":{"tags":["Counterparty","Payment Initiation Service (PIS)","Account","PSD2"],"summary":"Get Counterparties (Explicit)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

This endpoints gets the explicit Counterparties on an Account / View.

For a general introduction to Counterparties in OBP, see here

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

bespoke:

counterparties:

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

created_by_user_id:

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_beneficiary: false

key: CustomerNumber

name: ACCOUNT_MANAGEMENT_FEE

other_account_routing_address: DE89370400440532013000

other_account_routing_scheme: IBAN

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

this_account_id:

this_bank_id:

this_view_id:

value: 5987953

","operationId":"OBPv2.2.0-getExplicitCounterpartiesForAccount","parameters":[{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CounterpartiesJsonV220"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Counterparty","Account"],"summary":"Create Counterparty (Explicit)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create Counterparty (Explicit) for an Account.

In OBP, there are two types of Counterparty.

Explicit Counterparties are created for the account / view
They are how the user of the view (e.g. account owner) refers to the other side of the transaction

name : the human readable name (e.g. Piano teacher, Miss Nipa)

description : the human readable name (e.g. Piano teacher, Miss Nipa)

bank_routing_scheme : eg: bankId or bankCode or any other strings

bank_routing_address : eg: gh.29.uk, must be valid sandbox bankIds

account_routing_scheme : eg: AccountId or AccountNumber or any other strings

account_routing_address : eg: 1d65db7c-a7b2-4839-af41-95, must be valid accountIds

other_account_secondary_routing_scheme : eg: IBan or any other strings

other_account_secondary_routing_address : if it is an IBAN, it should be unique for each counterparty.

other_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode.

other_branch_routing_address : eg: branch-id-123 or you can leave it empty, not useful in sandbox mode.

is_beneficiary : must be set to true in order to send payments to this counterparty

bespoke: It supports a list of key-value, you can add it to the counterparty.

bespoke.key : any info-key you want to add to this counterparty

bespoke.value : any info-value you want to add to this counterparty

The view specified by VIEW_ID must have the canAddCounterparty permission

A minimal example for TransactionRequestType == COUNTERPARTY
{
"name": "Tesobe1",
"description": "Good Company",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"is_beneficiary": true,
"other_account_secondary_routing_scheme": "",
"other_account_secondary_routing_address": "",
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}

A minimal example for TransactionRequestType == SEPA

{
"name": "Tesobe2",
"description": "Good Company",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"other_account_secondary_routing_scheme": "IBAN",
"other_account_secondary_routing_address": "DE89 3704 0044 0532 0130 00",
"is_beneficiary": true,
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON request body fields:

bespoke:

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_beneficiary: false

key: CustomerNumber

name: ACCOUNT_MANAGEMENT_FEE

other_account_routing_address: DE89370400440532013000

other_account_routing_scheme: IBAN

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

value: 5987953

JSON response body fields:

bespoke:

corporate_location: 10

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

created_by_user_id:

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_url:

is_beneficiary: false

key: CustomerNumber

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

open_corporates_url:

other_account_routing_address: DE89370400440532013000

other_account_routing_scheme: IBAN

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

this_account_id:

this_bank_id:

this_view_id:

url: http://www.example.com/id-docs/123/image.png

user:

username: felixsmith

value: 5987953

","operationId":"OBPv2.2.0-createCounterparty","parameters":[{"in":"body","name":"body","description":"PostCounterpartyJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostCounterpartyJSON"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CounterpartyWithMetadataJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/counterparties/{COUNTERPARTY_ID}":{"get":{"tags":["Counterparty","Payment Initiation Service (PIS)","Counterparty-Metadata","PSD2"],"summary":"Get Counterparty by Counterparty Id (Explicit)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Information returned about the Counterparty specified by COUNTERPARTY_ID:

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

BANK_ID: gh.29.uk

COUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

VIEW_ID: owner

JSON response body fields:

bespoke:

corporate_location: 10

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

created_by_user_id:

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_url:

is_beneficiary: false

key: CustomerNumber

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

open_corporates_url:

other_account_routing_address: DE89370400440532013000

other_account_routing_scheme: IBAN

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

this_account_id:

this_bank_id:

this_view_id:

url: http://www.example.com/id-docs/123/image.png

user:

username: felixsmith

value: 5987953

","operationId":"OBPv2.2.0-getExplicitCounterpartyById","parameters":[{"in":"path","name":"COUNTERPARTY_ID","description":"the counterparty id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CounterpartyWithMetadataJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transaction-request-types":{"get":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Get Transaction Request Types for Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the Transaction Request Types that the account specified by ACCOUNT_ID and view specified by VIEW_ID has access to.

These are the ways this API Server can create a Transaction via a Transaction Request
(as opposed to Transaction Types which include external types too e.g. for Transactions created by core banking etc.)

A Transaction Request Type internally determines:

For instance in a 'SANDBOX_TAN' Transaction Request, for amounts over 1000 currency units, the user must supply a positive integer to complete the Transaction Request and create a Transaction.

This approach aims to provide only one endpoint for initiating transactions, and one that handles challenges, whilst still allowing flexibility with the payload and internal logic.

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

amount: 10.12

charge:

currency: EUR

summary:

transaction_request_types:

value: 5987953

","operationId":"OBPv1.4.0-getTransactionRequestTypes","parameters":[{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestTypesJsonV140"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transaction-request-types/COUNTERPARTY/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (COUNTERPARTY)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Special instructions for COUNTERPARTY:

When using a COUNTERPARTY to create a Transaction Request, specificy the counterparty_id in the body of the request.
The routing details of the counterparty will be forwarded for the transfer.

Initiate a Payment via creating a Transaction Request.

In OBP, a transaction request may or may not result in a transaction. However, a transaction only has one possible state: completed.

A Transaction Request can have one of several states.

Transactions are modeled on items in a bank statement that represent the movement of money.

Transaction Requests are requests to move money which may or may not succeeed and thus result in a Transaction.

A Transaction Request might create a security challenge that needs to be answered before the Transaction Request proceeds.

Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).

Transaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
This provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.

The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.

In sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.

In sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.

If a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.

You can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.

The following static FX rates are available in sandbox mode:

{
"XAF":{
"XAF":1.0,
"HKD":0.0135503,
"AUD":0.00228226,
"KRW":1.87975,
"JOD":0.00127784,
"GBP":0.00131092,
"MXN":0.0396,
"AED":0.00601555,
"INR":0.110241,
"XBT":2.9074795E-8,
"JPY":0.185328,
"USD":0.00163773,
"ILS":0.00641333,
"EUR":0.00152449
},
"HKD":{
"XAF":73.8049,
"HKD":1.0,
"AUD":0.178137,
"KRW":143.424,
"JOD":0.0903452,
"GBP":0.0985443,
"MXN":2.8067,
"AED":0.467977,
"INR":9.09325,
"XBT":2.164242461E-6,
"JPY":14.0867,
"USD":0.127427,
"ILS":0.460862,
"EUR":0.112495
},
"AUD":{
"XAF":438.162,
"HKD":5.61346,
"AUD":1.0,
"KRW":895.304,
"JOD":0.556152,
"GBP":0.609788,
"MXN":16.0826,
"AED":2.88368,
"INR":50.4238,
"XBT":1.2284055924E-5,
"JPY":87.0936,
"USD":0.785256,
"ILS":2.83558,
"EUR":0.667969
},
"KRW":{
"XAF":0.531986,
"HKD":0.00697233,
"AUD":0.00111694,
"KRW":1.0,
"JOD":6.30634E-4,
"GBP":6.97389E-4,
"MXN":0.0183,
"AED":0.00320019,
"INR":0.0586469,
"XBT":1.4234725E-8,
"JPY":0.0985917,
"USD":8.7125E-4,
"ILS":0.00316552,
"EUR":8.11008E-4
},
"JOD":{
"XAF":782.572,
"HKD":11.0687,
"AUD":1.63992,
"KRW":1585.68,
"JOD":1.0,
"GBP":1.06757,
"MXN":30.8336,
"AED":5.18231,
"INR":90.1236,
"XBT":2.3803244006E-5,
"JPY":156.304,
"USD":1.41112,
"ILS":5.02018,
"EUR":0.237707
},
"GBP":{
"XAF":762.826,
"HKD":10.1468,
"AUD":1.63992,
"KRW":1433.92,
"JOD":0.936707,
"GBP":1.0,
"MXN":29.242,
"AED":4.58882,
"INR":84.095,
"XBT":2.2756409956E-5,
"JPY":141.373,
"USD":1.2493,
"ILS":4.7002,
"EUR":1.16278
},
"MXN":{
"XAF":25.189,
"HKD":0.3562,
"AUD":0.0621,
"KRW":54.4512,
"JOD":0.0324,
"GBP":0.0341,
"MXN":1.0,
"AED":0.1688,
"INR":3.3513,
"XBT":8.1112586E-7,
"JPY":4.8687,
"USD":0.0459,
"ILS":0.1541,
"EUR":0.0384
},
"AED":{
"XAF":166.236,
"HKD":2.13685,
"AUD":0.346779,
"KRW":312.482,
"JOD":0.1930565,
"GBP":0.217921,
"MXN":5.9217,
"AED":1.0,
"INR":18.3255,
"XBT":4.603349217E-6,
"JPY":30.8081,
"USD":0.27225,
"ILS":0.968033,
"EUR":0.253425
},
"INR":{
"XAF":9.07101,
"HKD":0.109972,
"AUD":0.0198319,
"KRW":17.0512,
"JOD":0.0110959,
"GBP":0.0118913,
"MXN":0.2983,
"AED":0.0545671,
"INR":1.0,
"XBT":2.2689396E-7,
"JPY":1.68111,
"USD":0.0148559,
"ILS":0.0556764,
"EUR":0.0138287
},
"XBT":{
"XAF":3.4353824E7,
"HKD":460448.9,
"AUD":81168.603,
"KRW":7.0131575E7,
"JOD":41960.111,
"GBP":44188.118,
"MXN":1230503.3,
"AED":217414.47,
"INR":4407607.74,
"XBT":1.0,
"JPY":6805170.8,
"USD":59245.918,
"ILS":182981.21,
"EUR":52436.431
},
"JPY":{
"XAF":5.39585,
"HKD":0.0709891,
"AUD":0.0114819,
"KRW":10.1428,
"JOD":0.00639777,
"GBP":0.0070735,
"MXN":0.2053,
"AED":0.032459,
"INR":0.594846,
"XBT":1.47171931E-7,
"JPY":1.0,
"USD":0.00883695,
"ILS":0.0320926,
"EUR":0.00822592
},
"USD":{
"XAF":610.601,
"HKD":7.84766,
"AUD":1.27347,
"KRW":1147.78,
"JOD":0.708659,
"GBP":0.800446,
"MXN":21.748,
"AED":3.6731,
"INR":67.3135,
"XBT":1.69154E-5,
"JPY":113.161,
"USD":1.0,
"ILS":3.55495,
"EUR":0.930886
},
"ILS":{
"XAF":155.925,
"HKD":2.16985,
"AUD":0.352661,
"KRW":315.903,
"JOD":0.199196,
"GBP":0.212763,
"MXN":6.4871,
"AED":1.03302,
"INR":17.9609,
"XBT":5.452272147E-6,
"JPY":31.1599,
"USD":0.281298,
"ILS":1.0,
"EUR":1.19318
},
"EUR":{
"XAF":655.957,
"HKD":8.88926,
"AUD":1.49707,
"KRW":1233.03,
"JOD":0.838098,
"GBP":0.860011,
"MXN":26.0359,
"AED":3.94594,
"INR":72.3136,
"XBT":1.9087905636E-5,
"JPY":121.567,
"USD":1.07428,
"ILS":4.20494,
"EUR":1.0
}
}

Transaction Requests satisfy PSD2 requirements thus:

1) A transaction can be initiated by a third party application.

2) The customer is informed of the charge that will incurred.

3) The call supports delegated authentication (OAuth)

See this python code for a complete example of this flow.

There is further documentation here

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

BANK_ID: gh.29.uk

COUNTERPARTY:

VIEW_ID: owner

JSON request body fields:

amount: 10.12

attribute_type: STRING

charge_policy: SHARED

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

name: ACCOUNT_MANAGEMENT_FEE

to:

value: 5987953

attributes: attribute value in form of (name, value)

future_date: 20200127

JSON response body fields:

account:

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

agent_number: 5987953

allowed_attempts: 5

amount: 10.12

bank_code: CGHZ

bank_id: gh.29.uk

branch_number:

challenge:

challenge_type:

charge:

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

creditorAccount:

creditorName:

currency: EUR

date_of_birth: 2018-03-09

debtorAccount:

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

end_date:

from:

future_date: 20200127

iban: DE91 1000 0000 0123 4567 89

id: d8839721-ad8f-45dd-9f78-2080414b93f9

instructedAmount: 100

kyc_document:

legal_name: Eveline Tripman

message: 123456

mobile_phone_number: +49 30 901820

name: ACCOUNT_MANAGEMENT_FEE

nickname:

number:

otherAccountRoutingAddress: otherAccountRoutingAddress

otherAccountRoutingScheme: otherAccountRoutingScheme

otherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress

otherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme

otherBankRoutingAddress: otherBankRoutingAddress

otherBankRoutingScheme: otherBankRoutingScheme

otherBranchRoutingAddress: otherBranchRoutingAddress

otherBranchRoutingScheme: otherBranchRoutingScheme

start_date: 2020-01-27

status:

summary:

to:

transaction_ids:

transfer_type:

type:

value: 5987953

to_agent: to_agent

to_counterparty:

to_sandbox_tan:

to_sepa:

to_sepa_credit_transfers:

to_simple: to_simple

to_transfer_to_account:

to_transfer_to_atm:

to_transfer_to_phone:

","operationId":"OBPv2.1.0-createTransactionRequestCounterparty","parameters":[{"in":"body","name":"body","description":"TransactionRequestBodyCounterpartyJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestBodyCounterpartyJSON"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transaction-request-types/FREE_FORM/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)"],"summary":"Create Transaction Request (FREE_FORM)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Initiate a Payment via creating a Transaction Request.

In OBP, a transaction request may or may not result in a transaction. However, a transaction only has one possible state: completed.

A Transaction Request can have one of several states.

Transactions are modeled on items in a bank statement that represent the movement of money.

Transaction Requests are requests to move money which may or may not succeeed and thus result in a Transaction.

A Transaction Request might create a security challenge that needs to be answered before the Transaction Request proceeds.

Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).

Transaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
This provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.

The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.

In sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.

In sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.

If a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.

You can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.

The following static FX rates are available in sandbox mode:

{
"XAF":{
"XAF":1.0,
"HKD":0.0135503,
"AUD":0.00228226,
"KRW":1.87975,
"JOD":0.00127784,
"GBP":0.00131092,
"MXN":0.0396,
"AED":0.00601555,
"INR":0.110241,
"XBT":2.9074795E-8,
"JPY":0.185328,
"USD":0.00163773,
"ILS":0.00641333,
"EUR":0.00152449
},
"HKD":{
"XAF":73.8049,
"HKD":1.0,
"AUD":0.178137,
"KRW":143.424,
"JOD":0.0903452,
"GBP":0.0985443,
"MXN":2.8067,
"AED":0.467977,
"INR":9.09325,
"XBT":2.164242461E-6,
"JPY":14.0867,
"USD":0.127427,
"ILS":0.460862,
"EUR":0.112495
},
"AUD":{
"XAF":438.162,
"HKD":5.61346,
"AUD":1.0,
"KRW":895.304,
"JOD":0.556152,
"GBP":0.609788,
"MXN":16.0826,
"AED":2.88368,
"INR":50.4238,
"XBT":1.2284055924E-5,
"JPY":87.0936,
"USD":0.785256,
"ILS":2.83558,
"EUR":0.667969
},
"KRW":{
"XAF":0.531986,
"HKD":0.00697233,
"AUD":0.00111694,
"KRW":1.0,
"JOD":6.30634E-4,
"GBP":6.97389E-4,
"MXN":0.0183,
"AED":0.00320019,
"INR":0.0586469,
"XBT":1.4234725E-8,
"JPY":0.0985917,
"USD":8.7125E-4,
"ILS":0.00316552,
"EUR":8.11008E-4
},
"JOD":{
"XAF":782.572,
"HKD":11.0687,
"AUD":1.63992,
"KRW":1585.68,
"JOD":1.0,
"GBP":1.06757,
"MXN":30.8336,
"AED":5.18231,
"INR":90.1236,
"XBT":2.3803244006E-5,
"JPY":156.304,
"USD":1.41112,
"ILS":5.02018,
"EUR":0.237707
},
"GBP":{
"XAF":762.826,
"HKD":10.1468,
"AUD":1.63992,
"KRW":1433.92,
"JOD":0.936707,
"GBP":1.0,
"MXN":29.242,
"AED":4.58882,
"INR":84.095,
"XBT":2.2756409956E-5,
"JPY":141.373,
"USD":1.2493,
"ILS":4.7002,
"EUR":1.16278
},
"MXN":{
"XAF":25.189,
"HKD":0.3562,
"AUD":0.0621,
"KRW":54.4512,
"JOD":0.0324,
"GBP":0.0341,
"MXN":1.0,
"AED":0.1688,
"INR":3.3513,
"XBT":8.1112586E-7,
"JPY":4.8687,
"USD":0.0459,
"ILS":0.1541,
"EUR":0.0384
},
"AED":{
"XAF":166.236,
"HKD":2.13685,
"AUD":0.346779,
"KRW":312.482,
"JOD":0.1930565,
"GBP":0.217921,
"MXN":5.9217,
"AED":1.0,
"INR":18.3255,
"XBT":4.603349217E-6,
"JPY":30.8081,
"USD":0.27225,
"ILS":0.968033,
"EUR":0.253425
},
"INR":{
"XAF":9.07101,
"HKD":0.109972,
"AUD":0.0198319,
"KRW":17.0512,
"JOD":0.0110959,
"GBP":0.0118913,
"MXN":0.2983,
"AED":0.0545671,
"INR":1.0,
"XBT":2.2689396E-7,
"JPY":1.68111,
"USD":0.0148559,
"ILS":0.0556764,
"EUR":0.0138287
},
"XBT":{
"XAF":3.4353824E7,
"HKD":460448.9,
"AUD":81168.603,
"KRW":7.0131575E7,
"JOD":41960.111,
"GBP":44188.118,
"MXN":1230503.3,
"AED":217414.47,
"INR":4407607.74,
"XBT":1.0,
"JPY":6805170.8,
"USD":59245.918,
"ILS":182981.21,
"EUR":52436.431
},
"JPY":{
"XAF":5.39585,
"HKD":0.0709891,
"AUD":0.0114819,
"KRW":10.1428,
"JOD":0.00639777,
"GBP":0.0070735,
"MXN":0.2053,
"AED":0.032459,
"INR":0.594846,
"XBT":1.47171931E-7,
"JPY":1.0,
"USD":0.00883695,
"ILS":0.0320926,
"EUR":0.00822592
},
"USD":{
"XAF":610.601,
"HKD":7.84766,
"AUD":1.27347,
"KRW":1147.78,
"JOD":0.708659,
"GBP":0.800446,
"MXN":21.748,
"AED":3.6731,
"INR":67.3135,
"XBT":1.69154E-5,
"JPY":113.161,
"USD":1.0,
"ILS":3.55495,
"EUR":0.930886
},
"ILS":{
"XAF":155.925,
"HKD":2.16985,
"AUD":0.352661,
"KRW":315.903,
"JOD":0.199196,
"GBP":0.212763,
"MXN":6.4871,
"AED":1.03302,
"INR":17.9609,
"XBT":5.452272147E-6,
"JPY":31.1599,
"USD":0.281298,
"ILS":1.0,
"EUR":1.19318
},
"EUR":{
"XAF":655.957,
"HKD":8.88926,
"AUD":1.49707,
"KRW":1233.03,
"JOD":0.838098,
"GBP":0.860011,
"MXN":26.0359,
"AED":3.94594,
"INR":72.3136,
"XBT":1.9087905636E-5,
"JPY":121.567,
"USD":1.07428,
"ILS":4.20494,
"EUR":1.0
}
}

Transaction Requests satisfy PSD2 requirements thus:

1) A transaction can be initiated by a third party application.

2) The customer is informed of the charge that will incurred.

3) The call supports delegated authentication (OAuth)

See this python code for a complete example of this flow.

There is further documentation here

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

BANK_ID: gh.29.uk

FREE_FORM:

VIEW_ID: owner

JSON request body fields:

amount: 10.12

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

value: 5987953

JSON response body fields:

account:

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

agent_number: 5987953

allowed_attempts: 5

amount: 10.12

bank_code: CGHZ

bank_id: gh.29.uk

branch_number:

challenge:

challenge_type:

charge:

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

creditorAccount:

creditorName:

currency: EUR

date_of_birth: 2018-03-09

debtorAccount:

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

end_date:

from:

future_date: 20200127

iban: DE91 1000 0000 0123 4567 89

id: d8839721-ad8f-45dd-9f78-2080414b93f9

instructedAmount: 100

kyc_document:

legal_name: Eveline Tripman

message: 123456

mobile_phone_number: +49 30 901820

name: ACCOUNT_MANAGEMENT_FEE

nickname:

number:

otherAccountRoutingAddress: otherAccountRoutingAddress

otherAccountRoutingScheme: otherAccountRoutingScheme

otherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress

otherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme

otherBankRoutingAddress: otherBankRoutingAddress

otherBankRoutingScheme: otherBankRoutingScheme

otherBranchRoutingAddress: otherBranchRoutingAddress

otherBranchRoutingScheme: otherBranchRoutingScheme

start_date: 2020-01-27

status:

summary:

to:

transaction_ids:

transfer_type:

type:

value: 5987953

to_agent: to_agent

to_counterparty:

to_sandbox_tan:

to_sepa:

to_sepa_credit_transfers:

to_simple: to_simple

to_transfer_to_account:

to_transfer_to_atm:

to_transfer_to_phone:

","operationId":"OBPv2.1.0-createTransactionRequestFreeForm","parameters":[{"in":"body","name":"body","description":"TransactionRequestBodyFreeFormJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestBodyFreeFormJSON"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transaction-request-types/SANDBOX_TAN/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (SANDBOX_TAN)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

When using SANDBOX_TAN, the payee is set in the request body.

Money goes into the BANK_ID and ACCOUNT_ID specified in the request body.

Initiate a Payment via creating a Transaction Request.

In OBP, a transaction request may or may not result in a transaction. However, a transaction only has one possible state: completed.

A Transaction Request can have one of several states.

Transactions are modeled on items in a bank statement that represent the movement of money.

Transaction Requests are requests to move money which may or may not succeeed and thus result in a Transaction.

A Transaction Request might create a security challenge that needs to be answered before the Transaction Request proceeds.

Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).

Transaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
This provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.

The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.

In sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.

In sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.

If a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.

You can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.

The following static FX rates are available in sandbox mode:

{
"XAF":{
"XAF":1.0,
"HKD":0.0135503,
"AUD":0.00228226,
"KRW":1.87975,
"JOD":0.00127784,
"GBP":0.00131092,
"MXN":0.0396,
"AED":0.00601555,
"INR":0.110241,
"XBT":2.9074795E-8,
"JPY":0.185328,
"USD":0.00163773,
"ILS":0.00641333,
"EUR":0.00152449
},
"HKD":{
"XAF":73.8049,
"HKD":1.0,
"AUD":0.178137,
"KRW":143.424,
"JOD":0.0903452,
"GBP":0.0985443,
"MXN":2.8067,
"AED":0.467977,
"INR":9.09325,
"XBT":2.164242461E-6,
"JPY":14.0867,
"USD":0.127427,
"ILS":0.460862,
"EUR":0.112495
},
"AUD":{
"XAF":438.162,
"HKD":5.61346,
"AUD":1.0,
"KRW":895.304,
"JOD":0.556152,
"GBP":0.609788,
"MXN":16.0826,
"AED":2.88368,
"INR":50.4238,
"XBT":1.2284055924E-5,
"JPY":87.0936,
"USD":0.785256,
"ILS":2.83558,
"EUR":0.667969
},
"KRW":{
"XAF":0.531986,
"HKD":0.00697233,
"AUD":0.00111694,
"KRW":1.0,
"JOD":6.30634E-4,
"GBP":6.97389E-4,
"MXN":0.0183,
"AED":0.00320019,
"INR":0.0586469,
"XBT":1.4234725E-8,
"JPY":0.0985917,
"USD":8.7125E-4,
"ILS":0.00316552,
"EUR":8.11008E-4
},
"JOD":{
"XAF":782.572,
"HKD":11.0687,
"AUD":1.63992,
"KRW":1585.68,
"JOD":1.0,
"GBP":1.06757,
"MXN":30.8336,
"AED":5.18231,
"INR":90.1236,
"XBT":2.3803244006E-5,
"JPY":156.304,
"USD":1.41112,
"ILS":5.02018,
"EUR":0.237707
},
"GBP":{
"XAF":762.826,
"HKD":10.1468,
"AUD":1.63992,
"KRW":1433.92,
"JOD":0.936707,
"GBP":1.0,
"MXN":29.242,
"AED":4.58882,
"INR":84.095,
"XBT":2.2756409956E-5,
"JPY":141.373,
"USD":1.2493,
"ILS":4.7002,
"EUR":1.16278
},
"MXN":{
"XAF":25.189,
"HKD":0.3562,
"AUD":0.0621,
"KRW":54.4512,
"JOD":0.0324,
"GBP":0.0341,
"MXN":1.0,
"AED":0.1688,
"INR":3.3513,
"XBT":8.1112586E-7,
"JPY":4.8687,
"USD":0.0459,
"ILS":0.1541,
"EUR":0.0384
},
"AED":{
"XAF":166.236,
"HKD":2.13685,
"AUD":0.346779,
"KRW":312.482,
"JOD":0.1930565,
"GBP":0.217921,
"MXN":5.9217,
"AED":1.0,
"INR":18.3255,
"XBT":4.603349217E-6,
"JPY":30.8081,
"USD":0.27225,
"ILS":0.968033,
"EUR":0.253425
},
"INR":{
"XAF":9.07101,
"HKD":0.109972,
"AUD":0.0198319,
"KRW":17.0512,
"JOD":0.0110959,
"GBP":0.0118913,
"MXN":0.2983,
"AED":0.0545671,
"INR":1.0,
"XBT":2.2689396E-7,
"JPY":1.68111,
"USD":0.0148559,
"ILS":0.0556764,
"EUR":0.0138287
},
"XBT":{
"XAF":3.4353824E7,
"HKD":460448.9,
"AUD":81168.603,
"KRW":7.0131575E7,
"JOD":41960.111,
"GBP":44188.118,
"MXN":1230503.3,
"AED":217414.47,
"INR":4407607.74,
"XBT":1.0,
"JPY":6805170.8,
"USD":59245.918,
"ILS":182981.21,
"EUR":52436.431
},
"JPY":{
"XAF":5.39585,
"HKD":0.0709891,
"AUD":0.0114819,
"KRW":10.1428,
"JOD":0.00639777,
"GBP":0.0070735,
"MXN":0.2053,
"AED":0.032459,
"INR":0.594846,
"XBT":1.47171931E-7,
"JPY":1.0,
"USD":0.00883695,
"ILS":0.0320926,
"EUR":0.00822592
},
"USD":{
"XAF":610.601,
"HKD":7.84766,
"AUD":1.27347,
"KRW":1147.78,
"JOD":0.708659,
"GBP":0.800446,
"MXN":21.748,
"AED":3.6731,
"INR":67.3135,
"XBT":1.69154E-5,
"JPY":113.161,
"USD":1.0,
"ILS":3.55495,
"EUR":0.930886
},
"ILS":{
"XAF":155.925,
"HKD":2.16985,
"AUD":0.352661,
"KRW":315.903,
"JOD":0.199196,
"GBP":0.212763,
"MXN":6.4871,
"AED":1.03302,
"INR":17.9609,
"XBT":5.452272147E-6,
"JPY":31.1599,
"USD":0.281298,
"ILS":1.0,
"EUR":1.19318
},
"EUR":{
"XAF":655.957,
"HKD":8.88926,
"AUD":1.49707,
"KRW":1233.03,
"JOD":0.838098,
"GBP":0.860011,
"MXN":26.0359,
"AED":3.94594,
"INR":72.3136,
"XBT":1.9087905636E-5,
"JPY":121.567,
"USD":1.07428,
"ILS":4.20494,
"EUR":1.0
}
}

Transaction Requests satisfy PSD2 requirements thus:

1) A transaction can be initiated by a third party application.

2) The customer is informed of the charge that will incurred.

3) The call supports delegated authentication (OAuth)

See this python code for a complete example of this flow.

There is further documentation here

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

BANK_ID: gh.29.uk

SANDBOX_TAN:

VIEW_ID: owner

JSON request body fields:

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

amount: 10.12

bank_id: gh.29.uk

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

to:

value: 5987953

JSON response body fields:

account:

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

agent_number: 5987953

allowed_attempts: 5

amount: 10.12

bank_code: CGHZ

bank_id: gh.29.uk

branch_number:

challenge:

challenge_type:

charge:

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

creditorAccount:

creditorName:

currency: EUR

date_of_birth: 2018-03-09

debtorAccount:

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

end_date:

from:

future_date: 20200127

iban: DE91 1000 0000 0123 4567 89

id: d8839721-ad8f-45dd-9f78-2080414b93f9

instructedAmount: 100

kyc_document:

legal_name: Eveline Tripman

message: 123456

mobile_phone_number: +49 30 901820

name: ACCOUNT_MANAGEMENT_FEE

nickname:

number:

otherAccountRoutingAddress: otherAccountRoutingAddress

otherAccountRoutingScheme: otherAccountRoutingScheme

otherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress

otherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme

otherBankRoutingAddress: otherBankRoutingAddress

otherBankRoutingScheme: otherBankRoutingScheme

otherBranchRoutingAddress: otherBranchRoutingAddress

otherBranchRoutingScheme: otherBranchRoutingScheme

start_date: 2020-01-27

status:

summary:

to:

transaction_ids:

transfer_type:

type:

value: 5987953

to_agent: to_agent

to_counterparty:

to_sandbox_tan:

to_sepa:

to_sepa_credit_transfers:

to_simple: to_simple

to_transfer_to_account:

to_transfer_to_atm:

to_transfer_to_phone:

","operationId":"OBPv2.1.0-createTransactionRequestSandboxTan","parameters":[{"in":"body","name":"body","description":"TransactionRequestBodyJsonV200 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestBodyJsonV200"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transaction-request-types/SEPA/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (SEPA)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Special instructions for SEPA:

When using a SEPA Transaction Request, you specify the IBAN of a Counterparty in the body of the request.
The routing details (IBAN) of the counterparty will be forwarded to the core banking system for the transfer.

Initiate a Payment via creating a Transaction Request.

In OBP, a transaction request may or may not result in a transaction. However, a transaction only has one possible state: completed.

A Transaction Request can have one of several states.

Transactions are modeled on items in a bank statement that represent the movement of money.

Transaction Requests are requests to move money which may or may not succeeed and thus result in a Transaction.

A Transaction Request might create a security challenge that needs to be answered before the Transaction Request proceeds.

Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).

Transaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
This provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.

The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.

In sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.

In sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.

If a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.

You can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.

The following static FX rates are available in sandbox mode:

{
"XAF":{
"XAF":1.0,
"HKD":0.0135503,
"AUD":0.00228226,
"KRW":1.87975,
"JOD":0.00127784,
"GBP":0.00131092,
"MXN":0.0396,
"AED":0.00601555,
"INR":0.110241,
"XBT":2.9074795E-8,
"JPY":0.185328,
"USD":0.00163773,
"ILS":0.00641333,
"EUR":0.00152449
},
"HKD":{
"XAF":73.8049,
"HKD":1.0,
"AUD":0.178137,
"KRW":143.424,
"JOD":0.0903452,
"GBP":0.0985443,
"MXN":2.8067,
"AED":0.467977,
"INR":9.09325,
"XBT":2.164242461E-6,
"JPY":14.0867,
"USD":0.127427,
"ILS":0.460862,
"EUR":0.112495
},
"AUD":{
"XAF":438.162,
"HKD":5.61346,
"AUD":1.0,
"KRW":895.304,
"JOD":0.556152,
"GBP":0.609788,
"MXN":16.0826,
"AED":2.88368,
"INR":50.4238,
"XBT":1.2284055924E-5,
"JPY":87.0936,
"USD":0.785256,
"ILS":2.83558,
"EUR":0.667969
},
"KRW":{
"XAF":0.531986,
"HKD":0.00697233,
"AUD":0.00111694,
"KRW":1.0,
"JOD":6.30634E-4,
"GBP":6.97389E-4,
"MXN":0.0183,
"AED":0.00320019,
"INR":0.0586469,
"XBT":1.4234725E-8,
"JPY":0.0985917,
"USD":8.7125E-4,
"ILS":0.00316552,
"EUR":8.11008E-4
},
"JOD":{
"XAF":782.572,
"HKD":11.0687,
"AUD":1.63992,
"KRW":1585.68,
"JOD":1.0,
"GBP":1.06757,
"MXN":30.8336,
"AED":5.18231,
"INR":90.1236,
"XBT":2.3803244006E-5,
"JPY":156.304,
"USD":1.41112,
"ILS":5.02018,
"EUR":0.237707
},
"GBP":{
"XAF":762.826,
"HKD":10.1468,
"AUD":1.63992,
"KRW":1433.92,
"JOD":0.936707,
"GBP":1.0,
"MXN":29.242,
"AED":4.58882,
"INR":84.095,
"XBT":2.2756409956E-5,
"JPY":141.373,
"USD":1.2493,
"ILS":4.7002,
"EUR":1.16278
},
"MXN":{
"XAF":25.189,
"HKD":0.3562,
"AUD":0.0621,
"KRW":54.4512,
"JOD":0.0324,
"GBP":0.0341,
"MXN":1.0,
"AED":0.1688,
"INR":3.3513,
"XBT":8.1112586E-7,
"JPY":4.8687,
"USD":0.0459,
"ILS":0.1541,
"EUR":0.0384
},
"AED":{
"XAF":166.236,
"HKD":2.13685,
"AUD":0.346779,
"KRW":312.482,
"JOD":0.1930565,
"GBP":0.217921,
"MXN":5.9217,
"AED":1.0,
"INR":18.3255,
"XBT":4.603349217E-6,
"JPY":30.8081,
"USD":0.27225,
"ILS":0.968033,
"EUR":0.253425
},
"INR":{
"XAF":9.07101,
"HKD":0.109972,
"AUD":0.0198319,
"KRW":17.0512,
"JOD":0.0110959,
"GBP":0.0118913,
"MXN":0.2983,
"AED":0.0545671,
"INR":1.0,
"XBT":2.2689396E-7,
"JPY":1.68111,
"USD":0.0148559,
"ILS":0.0556764,
"EUR":0.0138287
},
"XBT":{
"XAF":3.4353824E7,
"HKD":460448.9,
"AUD":81168.603,
"KRW":7.0131575E7,
"JOD":41960.111,
"GBP":44188.118,
"MXN":1230503.3,
"AED":217414.47,
"INR":4407607.74,
"XBT":1.0,
"JPY":6805170.8,
"USD":59245.918,
"ILS":182981.21,
"EUR":52436.431
},
"JPY":{
"XAF":5.39585,
"HKD":0.0709891,
"AUD":0.0114819,
"KRW":10.1428,
"JOD":0.00639777,
"GBP":0.0070735,
"MXN":0.2053,
"AED":0.032459,
"INR":0.594846,
"XBT":1.47171931E-7,
"JPY":1.0,
"USD":0.00883695,
"ILS":0.0320926,
"EUR":0.00822592
},
"USD":{
"XAF":610.601,
"HKD":7.84766,
"AUD":1.27347,
"KRW":1147.78,
"JOD":0.708659,
"GBP":0.800446,
"MXN":21.748,
"AED":3.6731,
"INR":67.3135,
"XBT":1.69154E-5,
"JPY":113.161,
"USD":1.0,
"ILS":3.55495,
"EUR":0.930886
},
"ILS":{
"XAF":155.925,
"HKD":2.16985,
"AUD":0.352661,
"KRW":315.903,
"JOD":0.199196,
"GBP":0.212763,
"MXN":6.4871,
"AED":1.03302,
"INR":17.9609,
"XBT":5.452272147E-6,
"JPY":31.1599,
"USD":0.281298,
"ILS":1.0,
"EUR":1.19318
},
"EUR":{
"XAF":655.957,
"HKD":8.88926,
"AUD":1.49707,
"KRW":1233.03,
"JOD":0.838098,
"GBP":0.860011,
"MXN":26.0359,
"AED":3.94594,
"INR":72.3136,
"XBT":1.9087905636E-5,
"JPY":121.567,
"USD":1.07428,
"ILS":4.20494,
"EUR":1.0
}
}

Transaction Requests satisfy PSD2 requirements thus:

1) A transaction can be initiated by a third party application.

2) The customer is informed of the charge that will incurred.

3) The call supports delegated authentication (OAuth)

See this python code for a complete example of this flow.

There is further documentation here

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

BANK_ID: gh.29.uk

SEPA:

VIEW_ID: owner

JSON request body fields:

amount: 10.12

charge_policy: SHARED

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

iban: DE91 1000 0000 0123 4567 89

to:

value: 5987953

future_date: 20200127

JSON response body fields:

account:

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

agent_number: 5987953

allowed_attempts: 5

amount: 10.12

bank_code: CGHZ

bank_id: gh.29.uk

branch_number:

challenge:

challenge_type:

charge:

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

creditorAccount:

creditorName:

currency: EUR

date_of_birth: 2018-03-09

debtorAccount:

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

end_date:

from:

future_date: 20200127

iban: DE91 1000 0000 0123 4567 89

id: d8839721-ad8f-45dd-9f78-2080414b93f9

instructedAmount: 100

kyc_document:

legal_name: Eveline Tripman

message: 123456

mobile_phone_number: +49 30 901820

name: ACCOUNT_MANAGEMENT_FEE

nickname:

number:

otherAccountRoutingAddress: otherAccountRoutingAddress

otherAccountRoutingScheme: otherAccountRoutingScheme

otherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress

otherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme

otherBankRoutingAddress: otherBankRoutingAddress

otherBankRoutingScheme: otherBankRoutingScheme

otherBranchRoutingAddress: otherBranchRoutingAddress

otherBranchRoutingScheme: otherBranchRoutingScheme

start_date: 2020-01-27

status:

summary:

to:

transaction_ids:

transfer_type:

type:

value: 5987953

to_agent: to_agent

to_counterparty:

to_sandbox_tan:

to_sepa:

to_sepa_credit_transfers:

to_simple: to_simple

to_transfer_to_account:

to_transfer_to_atm:

to_transfer_to_phone:

","operationId":"OBPv2.1.0-createTransactionRequestSepa","parameters":[{"in":"body","name":"body","description":"TransactionRequestBodySEPAJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestBodySEPAJSON"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transaction-request-types/{TRANSACTION_REQUEST_TYPE}/transaction-requests/{TRANSACTION_REQUEST_ID}/challenge":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Answer Transaction Request Challenge","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

In Sandbox mode, any string that can be converted to a positive integer will be accepted as an answer.

This endpoint expects the following data as provided in the createTransactionRequest response body:

1)TRANSACTION_REQUEST_TYPE : as per the selected createTransactionRequest type, part of the request URL.

2)TRANSACTION_REQUEST_ID : the value of the id field of the createTransactionRequest response body.

3) id : the value of challenge.id in the createTransactionRequest response body.

4) answer : Defaults to 123, if running in sandbox mode. In production mode, the value will be sent via the configured SCA method.

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

BANK_ID: gh.29.uk

TRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1

TRANSACTION_REQUEST_TYPE: SEPA

VIEW_ID: owner

JSON request body fields:

answer:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

JSON response body fields:

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

allowed_attempts: 5

amount: 10.12

bank_id: gh.29.uk

challenge:

challenge_type:

charge:

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

end_date:

from:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

start_date: 2020-01-27

status:

summary:

to:

transaction_ids:

type:

value: 5987953

","operationId":"OBPv2.1.0-answerTransactionRequestChallenge","parameters":[{"in":"body","name":"body","description":"ChallengeAnswerJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ChallengeAnswerJSON"}},{"in":"path","name":"TRANSACTION_REQUEST_ID","description":"The transaction request id","required":true,"type":"string"},{"in":"path","name":"TRANSACTION_REQUEST_TYPE","description":"The transaction request type","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transaction-requests":{"get":{"tags":["Transaction-Request","PSD2","Old-Style"],"summary":"Get Transaction Requests","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns transaction requests for account specified by ACCOUNT_ID at bank specified by BANK_ID.

The VIEW_ID specified must be 'owner' and the user must have access to this view.

Version 2.0.0 now returns charge information.

Transaction Requests serve to initiate transactions that may or may not proceed. They contain information including:

PSD2 Context: PSD2 requires transparency of charges to the customer.
This endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after.
The customer can proceed with the Transaction by answering the security challenge.

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

account:

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

agent_number: 5987953

allowed_attempts: 5

amount: 10.12

bank_code: CGHZ

bank_id: gh.29.uk

branch_number:

challenge:

challenge_type:

charge:

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

creditorAccount:

creditorName:

currency: EUR

date_of_birth: 2018-03-09

debtorAccount:

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

end_date:

from:

future_date: 20200127

iban: DE91 1000 0000 0123 4567 89

id: d8839721-ad8f-45dd-9f78-2080414b93f9

instructedAmount: 100

kyc_document:

legal_name: Eveline Tripman

message: 123456

mobile_phone_number: +49 30 901820

name: ACCOUNT_MANAGEMENT_FEE

nickname:

number:

otherAccountRoutingAddress: otherAccountRoutingAddress

otherAccountRoutingScheme: otherAccountRoutingScheme

otherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress

otherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme

otherBankRoutingAddress: otherBankRoutingAddress

otherBankRoutingScheme: otherBankRoutingScheme

otherBranchRoutingAddress: otherBranchRoutingAddress

otherBranchRoutingScheme: otherBranchRoutingScheme

start_date: 2020-01-27

status:

summary:

to:

transaction_ids:

transaction_requests_with_charges:

transfer_type:

type:

value: 5987953

to_agent: to_agent

to_counterparty:

to_sandbox_tan:

to_sepa:

to_sepa_credit_transfers:

to_simple: to_simple

to_transfer_to_account:

to_transfer_to_atm:

to_transfer_to_phone:

","operationId":"OBPv2.1.0-getTransactionRequests","parameters":[{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSONs210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/permissions":{"get":{"tags":["View-Custom","Account","User","Entitlement"],"summary":"Get access","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the list of the permissions at BANK_ID for account ACCOUNT_ID, with each time a pair composed of the user and the views that he has access to.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.
and the user needs to have access to the owner view.

URL Parameters:

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

BANK_ID: gh.29.uk

JSON response body fields:

alias:

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

display_name:

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

permissions:

provider: ETHEREUM

short_name:

user:

views:

","operationId":"OBPv2.0.0-getPermissionsForBankAccount","parameters":[{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/PermissionsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/permissions/{PROVIDER}/{PROVIDER_ID}":{"get":{"tags":["View-Custom","Account","User","Old-Style"],"summary":"Get Account access for User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the list of the views at BANK_ID for account ACCOUNT_ID that a user identified by PROVIDER_ID at their provider PROVIDER has access to.
All url parameters must be %-encoded, which is often especially relevant for USER_ID and PROVIDER.

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

The user needs to have access to the owner view.

URL Parameters:

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

BANK_ID: gh.29.uk

PROVIDER: ETHEREUM

PROVIDER_ID:

JSON response body fields:

alias:

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

short_name:

views:

","operationId":"OBPv2.0.0-getPermissionForUserForBankAccount","parameters":[{"in":"path","name":"PROVIDER","description":"the user PROVIDER","required":true,"type":"string"},{"in":"path","name":"PROVIDER_ID","description":"The provider id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ViewsJSONV121"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/views":{"get":{"tags":["View-Custom","Account"],"summary":"Get Views for Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Views

Views in Open Bank Project provide a mechanism for fine grained access control and delegation to Accounts and Transactions. Account holders use the 'owner' view by default.
Delegated access is made through other views for example 'accountants', 'share-holders' or 'tagging-application'. Views can be created via the API and each view has a list of entitlements.

Views on accounts and transactions filter the underlying data to redact certain fields for certain users. For instance the balance on an account may be hidden from the public. The way to know what is possible on a view is determined in the following JSON.

Data: When a view moderates a set of data, some fields my contain the value null rather than the original value. This indicates either that the user is not allowed to see the original data or the field is empty.

There is currently one exception to this rule; the 'holder' field in the JSON contains always a value which is either an alias or the real name - indicated by the 'is_alias' field.

Action: When a user performs an action like trying to post a comment (with POST API call), if he is not allowed, the body response will contain an error message.

Metadata:
Transaction metadata (like images, tags, comments, etc.) will appears ONLY on the view where they have been created e.g. comments posted to the public view only appear on the public view.

The other account metadata fields (like image_URL, more_info, etc.) are unique through all the views. Example, if a user edits the 'more_info' field in the 'team' view, then the view 'authorities' will show the new value (if it is allowed to do it).

All

Optional

Returns the list of the views created for account ACCOUNT_ID at BANK_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.

URL Parameters:

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

BANK_ID: gh.29.uk

JSON response body fields:

alias:

can_add_comment:

can_add_corporate_location:

can_add_counterparty: false

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

short_name:

views:

","operationId":"OBPv2.2.0-getViewsForBankAccount","parameters":[{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ViewsJSONV220"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Account","View-Custom","Old-Style"],"summary":"Create View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create a view on bank account

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.
The 'alias' field in the JSON can take one of three values:

The 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to true and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.

The 'allowed_actions' field is a list containing the name of the actions allowed on this view, all the actions contained will be set to true on the view creation, the rest will be set to false.

You should use a leading _ (underscore) for the view name because other view names may become reserved by OBP internally

URL Parameters:

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

BANK_ID: gh.29.uk

JSON request body fields:

allowed_actions:

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

is_public: false

name: ACCOUNT_MANAGEMENT_FEE

which_alias_to_use: public

JSON response body fields:

alias:

can_add_comment:

can_add_corporate_location:

can_add_counterparty: false

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

short_name:

","operationId":"OBPv2.2.0-createViewForBankAccount","parameters":[{"in":"body","name":"body","description":"CreateViewJsonV121 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateViewJsonV121"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/ViewJSONV220"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/views/{VIEW_ID}":{"put":{"tags":["Account","View-Custom","Old-Style"],"summary":"Update View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update an existing view on a bank account

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.

The json sent is the same as during view creation (above), with one difference: the 'name' field
of a view is not editable (it is only set when a view is created)

URL Parameters:

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

alias:

can_add_comment:

can_add_corporate_location:

can_add_counterparty: false

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

short_name:

","operationId":"OBPv2.2.0-updateViewForBankAccount","parameters":[{"in":"body","name":"body","description":"UpdateViewJsonV121 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/UpdateViewJsonV121"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ViewJSONV220"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/private":{"get":{"tags":["Account","PSD2"],"summary":"Get private accounts at one bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the list of private accounts at BANK_ID that the user has access to.
For each account the API returns the ID and the available views.

If you want to see more information on the Views, use the Account Detail call.
If you want less information about the account, use the /my accounts call

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

accounts:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

short_name:

views_available:

","operationId":"OBPv2.0.0-privateAccountsAtOneBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BasicAccountsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/accounts/public":{"get":{"tags":["Account-Public","Account","PublicData"],"summary":"Get Public Accounts at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

accounts:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

short_name:

views_available:

","operationId":"OBPv2.0.0-publicAccountsAtOneBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BasicAccountsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/atms":{"get":{"tags":["Bank","Old-Style"],"summary":"Get Bank ATMS","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns information about ATMs for a single bank specified by BANK_ID including:

Possible custom url parameters for pagination:

eg1:?limit=100&offset=0

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

address:

atms:

city:

country: Germany

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

license:

line_1:

line_2:

line_3:

location:

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

state:

","operationId":"OBPv1.4.0-getAtms","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AtmsJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"post":{"tags":["ATM"],"summary":"Create ATM","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create ATM for the Bank.

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

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

address:

bank_id: gh.29.uk

city:

country: Germany

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

license:

line_1:

line_2:

line_3:

location:

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

state:

JSON response body fields:

address:

bank_id: gh.29.uk

city:

country: Germany

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

license:

line_1:

line_2:

line_3:

location:

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

state:

","operationId":"OBPv2.2.0-createAtm","parameters":[{"in":"body","name":"body","description":"AtmJsonV220 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AtmJsonV220"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/AtmJsonV220"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/atms/{ATM_ID}":{"get":{"tags":["ATM","Old-Style"],"summary":"Get Bank ATM","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns information about ATM for a single bank specified by BANK_ID and ATM_ID including:

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

URL Parameters:

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

address:

city:

country: Germany

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

license:

line_1:

line_2:

line_3:

location:

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

state:

","operationId":"OBPv2.1.0-getAtm","parameters":[{"in":"path","name":"ATM_ID","description":"the atm id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AtmJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/branches":{"get":{"tags":["Branch","Old-Style"],"summary":"Get Bank Branches","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns information about branches for a single bank specified by BANK_ID including:

Possible custom url parameters for pagination:

eg1:?limit=100&offset=0

You can use the url query parameters limit and offset for pagination

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

address:

branch_routing:

branches:

city:

country: Germany

drive_up:

hours:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

license:

line_1:

line_2:

line_3:

lobby:

location:

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

scheme: OBP

state:

","operationId":"OBPv1.4.0-getBranches","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BranchesJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"post":{"tags":["Branch","Open-Data"],"summary":"Create Branch","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create Branch for the Bank.

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

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

address:

bank_id: gh.29.uk

branch_routing:

city:

country: Germany

drive_up:

hours:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

license:

line_1:

line_2:

line_3:

lobby:

location:

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

scheme: OBP

state:

JSON response body fields:

address:

bank_id: gh.29.uk

branch_routing:

city:

country: Germany

drive_up:

hours:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

license:

line_1:

line_2:

line_3:

lobby:

location:

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

scheme: OBP

state:

","operationId":"OBPv2.2.0-createBranch","parameters":[{"in":"body","name":"body","description":"BranchJsonV220 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/BranchJsonV220"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/BranchJsonV220"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/branches/{BRANCH_ID}":{"get":{"tags":["Branch","Old-Style"],"summary":"Get Bank Branch","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns information about branches for a single bank specified by BANK_ID and BRANCH_ID including:
meta.license.id and eta.license.name fields must not be empty.

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

URL Parameters:

BANK_ID: gh.29.uk

BRANCH_ID: DERBY6

JSON response body fields:

address:

branch_routing:

city:

country: Germany

drive_up:

hours:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

license:

line_1:

line_2:

line_3:

lobby:

location:

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

scheme: OBP

state:

","operationId":"OBPv2.1.0-getBranch","parameters":[{"in":"path","name":"BRANCH_ID","description":"The branch id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BranchJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBranchNotFoundByBranchId"}}}},"put":{"tags":["Branch"],"summary":"Update Branch","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update an existing branch for a bank account (Authenticated access).
User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

BRANCH_ID: DERBY6

JSON response body fields:

address:

branch_routing:

city:

country: Germany

drive_up:

hours:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

license:

line_1:

line_2:

line_3:

lobby:

location:

longitude: -77.0364

meta:

name: ACCOUNT_MANAGEMENT_FEE

postcode:

scheme: OBP

state:

","operationId":"OBPv2.1.0-updateBranch","parameters":[{"in":"body","name":"body","description":"BranchJsonPutV210 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/BranchJsonPutV210"}},{"in":"path","name":"BRANCH_ID","description":"The branch id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BranchJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/cards":{"get":{"tags":["Card"],"summary":"Get cards for the specified bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

account:

alias:

allows: [credit,debit,cash_withdrawal]

bank_card_number: 364435172576215

bank_id: gh.29.uk

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

cancelled: false

cards:

collected: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

expires_date: 2021-01-27

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

issue_number: 1

label: My Account

name_on_card: SusanSmith

networks:

on_hot_list: false

pin_reset:

posted: 2020-01-27

reason_requested:

replacement:

requested_date: 2020-01-27

serial_number: 1324234

short_name:

technology: technology1

valid_from_date: 2020-01-27

views_available:

","operationId":"OBPv1.3.0-getCardsForBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/PhysicalCardsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Card"],"summary":"Create Card","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create Card at bank specified by BANK_ID .

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

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

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

allows: [credit,debit,cash_withdrawal]

bank_card_number: 364435172576215

collected: 2020-01-27

enabled: false

expires_date: 2021-01-27

issue_number: 1

name_on_card: SusanSmith

networks:

pin_reset:

posted: 2020-01-27

reason_requested:

replacement:

requested_date: 2020-01-27

serial_number: 1324234

technology: technology1

valid_from_date: 2020-01-27

JSON response body fields:

account:

alias:

allows: [credit,debit,cash_withdrawal]

bank_card_number: 364435172576215

bank_id: gh.29.uk

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

cancelled: false

collected: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

expires_date: 2021-01-27

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

issue_number: 1

label: My Account

name_on_card: SusanSmith

networks:

on_hot_list: false

pin_reset:

posted: 2020-01-27

reason_requested:

replacement:

requested_date: 2020-01-27

serial_number: 1324234

short_name:

technology: technology1

valid_from_date: 2020-01-27

views_available:

","operationId":"OBPv2.1.0-addCardsForBank","parameters":[{"in":"body","name":"body","description":"PostPhysicalCardJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostPhysicalCardJSON"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/PhysicalCardJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/crm-events":{"get":{"tags":["Customer"],"summary":"Get CRM Events","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

actual_date: 2020-01-27

bank_id: gh.29.uk

category:

channel:

crm_events:

customer_name:

customer_number: 5987953

detail:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

result:

scheduled_date: 2020-01-27

","operationId":"OBPv1.4.0-getCrmEvents","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CrmEventsJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/customer/{CUSTOMER_ID}/messages":{"post":{"tags":["Customer-Message","Customer","Person"],"summary":"Create Customer Message","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create a message for the customer specified by CUSTOMER_ID

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

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON request body fields:

from_department: Open Bank

from_person: Tom

message: 123456

JSON response body fields:

success:

","operationId":"OBPv1.4.0-addCustomerMessage","parameters":[{"in":"body","name":"body","description":"AddCustomerMessageJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AddCustomerMessageJson"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/customer/messages":{"get":{"tags":["Customer-Message","Customer"],"summary":"Get Customer Messages for all Customers","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get messages for the logged in customer
Messages sent to the currently authenticated user.

Authentication via OAuth is required.

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

date: 2020-01-27

from_department: Open Bank

from_person: Tom

id: d8839721-ad8f-45dd-9f78-2080414b93f9

message: 123456

messages:

","operationId":"OBPv1.4.0-getCustomersMessages","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerMessagesJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/customers":{"get":{"tags":["Customer"],"summary":"Get Customers for current User at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns a list of Customers at the Bank that are linked to the currently authenticated User.

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

currency: EUR

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

customers:

date: 2020-01-27

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2025-04-15T13:57:22.914Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

rating:

relationship_status: single

source:

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

","operationId":"OBPv2.1.0-getCustomersForCurrentUserAtBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJSONs"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Customer","Person","Old-Style"],"summary":"Create Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Add a customer linked to the user specified by user_id
The Customer resource stores the customer number, legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc.
Dates need to be in the format 2013-01-21T23:08:00Z

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

CanCreateCustomer and CanCreateUserCustomerLink OR CanCreateCustomerAtAnyBank and CanCreateUserCustomerLinkAtAnyBank

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

amount: 10.12

credit_limit:

credit_rating:

currency: EUR

customer_number: 5987953

date: 2020-01-27

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2025-04-15T13:57:22.914Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

rating:

relationship_status: single

source:

url: http://www.example.com/id-docs/123/image.png

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

currency: EUR

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date: 2020-01-27

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2025-04-15T13:57:22.914Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

rating:

relationship_status: single

source:

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

","operationId":"OBPv2.1.0-createCustomer","parameters":[{"in":"body","name":"body","description":"PostCustomerJsonV210 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostCustomerJsonV210"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/kyc_check/{KYC_CHECK_ID}":{"put":{"tags":["KYC","Customer"],"summary":"Add KYC Check","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Add a KYC check for the customer specified by CUSTOMER_ID. KYC Checks store details of checks on a customer made by the KYC team, their comments and a satisfied status

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

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

KYC_CHECK_ID:

JSON response body fields:

bank_id: gh.29.uk

comments:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date: 2020-01-27

how:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

satisfied: false

staff_name:

staff_user_id:

","operationId":"OBPv2.0.0-addKycCheck","parameters":[{"in":"body","name":"body","description":"PostKycCheckJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostKycCheckJSON"}},{"in":"path","name":"KYC_CHECK_ID","description":"The kyc check id","required":true,"type":"string"},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycCheckJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/kyc_documents/{KYC_DOCUMENT_ID}":{"put":{"tags":["KYC","Customer"],"summary":"Add KYC Document","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Add a KYC document for the customer specified by CUSTOMER_ID. KYC Documents contain the document type (e.g. passport), place of issue, expiry etc.

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

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

KYC_DOCUMENT_ID:

JSON response body fields:

bank_id: gh.29.uk

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

expiry_date: 2021-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

issue_date: 2020-01-27

issue_place:

number:

type:

","operationId":"OBPv2.0.0-addKycDocument","parameters":[{"in":"body","name":"body","description":"PostKycDocumentJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostKycDocumentJSON"}},{"in":"path","name":"KYC_DOCUMENT_ID","description":"The kyc document id","required":true,"type":"string"},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycDocumentJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/kyc_media/{KYC_MEDIA_ID}":{"put":{"tags":["KYC","Customer"],"summary":"Add KYC Media","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Add some KYC media for the customer specified by CUSTOMER_ID. KYC Media resources relate to KYC Documents and KYC Checks and contain media urls for scans of passports, utility bills etc

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

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

KYC_MEDIA_ID:

JSON response body fields:

bank_id: gh.29.uk

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

relates_to_kyc_check_id:

relates_to_kyc_document_id:

type:

url: http://www.example.com/id-docs/123/image.png

","operationId":"OBPv2.0.0-addKycMedia","parameters":[{"in":"body","name":"body","description":"PostKycMediaJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostKycMediaJSON"}},{"in":"path","name":"KYC_MEDIA_ID","description":"The kyc media id","required":true,"type":"string"},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycMediaJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/kyc_statuses":{"put":{"tags":["KYC","Customer"],"summary":"Add KYC Status","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Add a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer

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

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date: 2020-01-27

ok: false

","operationId":"OBPv2.0.0-addKycStatus","parameters":[{"in":"body","name":"body","description":"PostKycStatusJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostKycStatusJSON"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycStatusJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/social_media_handles":{"get":{"tags":["Customer"],"summary":"Get Customer Social Media Handles","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get social media handles for a customer specified by CUSTOMER_ID.

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

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

checks:

customer_number: 5987953

date_activated:

date_added:

handle:

type:

","operationId":"OBPv2.0.0-getSocialMediaHandles","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SocialMediasJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Customer"],"summary":"Create Customer Social Media Handle","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create a customer social media handle for the customer specified by CUSTOMER_ID

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

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON request body fields:

customer_number: 5987953

date_activated:

date_added:

handle:

type:

JSON response body fields:

success:

","operationId":"OBPv2.0.0-addSocialMediaHandle","parameters":[{"in":"body","name":"body","description":"SocialMediaJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/SocialMediaJSON"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/fx/{FROM_CURRENCY_CODE}/{TO_CURRENCY_CODE}":{"get":{"tags":["FX"],"summary":"Get Current FxRate","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get the latest FX rate specified by BANK_ID, FROM_CURRENCY_CODE and TO_CURRENCY_CODE

OBP may try different sources of FX rate information depending on the Connector in operation.

For example we want to convert EUR => USD:

OBP will:
1st try - Connector (database, core banking system or external FX service)
2nd try part 1 - fallbackexchangerates/eur.json
2nd try part 2 - fallbackexchangerates/usd.json (the inverse rate is used)
3rd try - Hardcoded map of FX rates.

\"FX

Public Access: This endpoint can be made publicly accessible (no authentication required) by setting the property apiOptions.getCurrentFxRateIsPublic=true in the props file.

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

URL Parameters:

BANK_ID: gh.29.uk

FROM_CURRENCY_CODE:

TO_CURRENCY_CODE: EUR

JSON response body fields:

bank_id: gh.29.uk

conversion_value: 100

effective_date: 2020-01-27

from_currency_code:

inverse_conversion_value: 50

to_currency_code: EUR

","operationId":"OBPv2.2.0-getCurrentFxRate","parameters":[{"in":"path","name":"TO_CURRENCY_CODE","description":"The to currency code","required":true,"type":"string"},{"in":"path","name":"FROM_CURRENCY_CODE","description":"The from currency code","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/FXRateJsonV220"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidISOCurrencyCode"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/products":{"get":{"tags":["Product"],"summary":"Get Bank Products","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns information about the financial products offered by a bank specified by BANK_ID including:

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_id: gh.29.uk

category:

code: 125

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

family:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

license:

meta:

more_info_url: www.example.com/abc

name: ACCOUNT_MANAGEMENT_FEE

products:

super_family:

","operationId":"OBPv2.1.0-getProducts","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ProductsJsonV210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"put":{"tags":["Product"],"summary":"Create Product","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create or Update Product for the Bank.

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_id: gh.29.uk

category:

code: 125

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

family:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

license:

meta:

more_info_url: www.example.com/abc

name: ACCOUNT_MANAGEMENT_FEE

super_family:

","operationId":"OBPv2.2.0-createProduct","parameters":[{"in":"body","name":"body","description":"ProductJsonV220 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ProductJsonV220"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ProductJsonV220"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/products/{PRODUCT_CODE}":{"get":{"tags":["Product"],"summary":"Get Bank Product","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns information about the financial products offered by a bank specified by BANK_ID and PRODUCT_CODE including:

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON response body fields:

bank_id: gh.29.uk

category:

code: 125

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

family:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

license:

meta:

more_info_url: www.example.com/abc

name: ACCOUNT_MANAGEMENT_FEE

super_family:

","operationId":"OBPv2.1.0-getProduct","parameters":[{"in":"path","name":"PRODUCT_CODE","description":"the product code","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ProductJsonV210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorProductNotFoundByProductCode"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/transaction-request-types":{"get":{"tags":["Transaction-Request","Bank"],"summary":"Get Transaction Request Types at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get the list of the Transaction Request Types supported by the bank.

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

transaction_request_type: SEPA

transaction_request_types:

","operationId":"OBPv2.1.0-getTransactionRequestTypesSupportedByBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestTypesJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/transaction-types":{"get":{"tags":["Bank","Account Information Service (AIS)","PSD2"],"summary":"Get Transaction Types at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get Transaction Types for the bank specified by BANK_ID:

Lists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

charge:

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

id: d8839721-ad8f-45dd-9f78-2080414b93f9

short_code:

summary:

transaction_types:

value: 5987953

","operationId":"OBPv2.0.0-getTransactionTypes","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionTypesJsonV200"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"put":{"tags":["Bank"],"summary":"Create Transaction Type at bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create Transaction Types for the bank specified by BANK_ID:

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

amount: 10.12

bankId:

charge:

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

id: d8839721-ad8f-45dd-9f78-2080414b93f9

shortCode:

summary:

value: 5987953

","operationId":"OBPv2.1.0-createTransactionType","parameters":[{"in":"body","name":"body","description":"TransactionTypeJsonV200 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionTypeJsonV200"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionType"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/user_customer_links":{"post":{"tags":["Customer","User","Old-Style"],"summary":"Create User Customer Link","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Link a User to a Customer

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

CanCreateUserCustomerLink OR CanCreateUserCustomerLinkAtAnyBank entitlements are required.

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

JSON response body fields:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

date_inserted:

is_active: false

user_customer_link_id:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

","operationId":"OBPv2.0.0-createUserCustomerLinks","parameters":[{"in":"body","name":"body","description":"CreateUserCustomerLinkJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateUserCustomerLinkJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/UserCustomerLinkJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/banks/{BANK_ID}/users/{USER_ID}/entitlements":{"get":{"tags":["Role","Entitlement","User"],"summary":"Get Entitlements for User at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get Entitlements specified by BANK_ID and USER_ID

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

URL Parameters:

BANK_ID: gh.29.uk

USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

JSON response body fields:

bank_id: gh.29.uk

entitlement_id:

list:

role_name:

","operationId":"OBPv2.1.0-getEntitlementsByBankAndUser","parameters":[{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EntitlementJSONs"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/cards":{"get":{"tags":["Card"],"summary":"Get cards for the current user","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc.

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

JSON response body fields:

account:

alias:

allows: [credit,debit,cash_withdrawal]

bank_card_number: 364435172576215

bank_id: gh.29.uk

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

cancelled: false

cards:

collected: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

expires_date: 2021-01-27

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

issue_number: 1

label: My Account

name_on_card: SusanSmith

networks:

on_hot_list: false

pin_reset:

posted: 2020-01-27

reason_requested:

replacement:

requested_date: 2020-01-27

serial_number: 1324234

short_name:

technology: technology1

valid_from_date: 2020-01-27

views_available:

","operationId":"OBPv1.3.0-getCards","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/PhysicalCardsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/config":{"get":{"tags":["API"],"summary":"Get API Configuration","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns information about:

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

JSON response body fields:

akka:

cache:

elastic_search:

function_name:

log_level:

metrics:

ports:

property:

require_scopes_for_all_roles:

require_scopes_for_listed_roles: false

scopes:

ttl_in_seconds:

value: 5987953

warehouse:

remote_data_secret_matched: remote_data_secret_matched

","operationId":"OBPv2.2.0-config","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ConfigurationJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/customers/{CUSTOMER_ID}/kyc_checks":{"get":{"tags":["KYC","Customer"],"summary":"Get Customer KYC Checks","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get KYC checks for the Customer specified by CUSTOMER_ID.

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

URL Parameters:

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

bank_id: gh.29.uk

checks:

comments:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date: 2020-01-27

how:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

satisfied: false

staff_name:

staff_user_id:

","operationId":"OBPv2.0.0-getKycChecks","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycChecksJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/customers/{CUSTOMER_ID}/kyc_documents":{"get":{"tags":["KYC","Customer"],"summary":"Get Customer KYC Documents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID
Get a list of documents that affirm the identity of the customer
Passport, driving licence etc.
User Authentication is Optional. The User need not be logged in.

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

URL Parameters:

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

bank_id: gh.29.uk

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

documents:

expiry_date: 2021-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

issue_date: 2020-01-27

issue_place:

number:

type:

","operationId":"OBPv2.0.0-getKycDocuments","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycDocumentsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/customers/{CUSTOMER_ID}/kyc_media":{"get":{"tags":["KYC","Customer"],"summary":"Get KYC Media for a customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get KYC media (scans, pictures, videos) that affirms the identity of the customer.

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

URL Parameters:

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

bank_id: gh.29.uk

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

medias:

relates_to_kyc_check_id:

relates_to_kyc_document_id:

type:

url: http://www.example.com/id-docs/123/image.png

","operationId":"OBPv2.0.0-getKycMedia","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycMediasJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/customers/{CUSTOMER_ID}/kyc_statuses":{"get":{"tags":["KYC","Customer"],"summary":"Get Customer KYC statuses","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get the KYC statuses for a customer specified by CUSTOMER_ID over time.

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

URL Parameters:

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date: 2020-01-27

ok: false

statuses:

","operationId":"OBPv2.0.0-getKycStatuses","parameters":[{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/KycStatusesJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/entitlements":{"get":{"tags":["Role","Entitlement"],"summary":"Get all Entitlements","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Login is required.

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

JSON response body fields:

bank_id: gh.29.uk

entitlement_id:

list:

role_name:

","operationId":"OBPv2.0.0-getAllEntitlements","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EntitlementJSONs"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/management/connector/metrics":{"get":{"tags":["Metric","API"],"summary":"Get Connector Metrics","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get the all metrics

require CanGetConnectorMetrics role

Filters Part 1.filtering (no wilde cards etc.) parameters to GET /management/connector/metrics

Should be able to filter on the following metrics fields

eg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2

1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z

2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z

3 limit (for pagination: defaults to 1000) eg:limit=2000

4 offset (for pagination: zero index, defaults to 0) eg: offset=10

eg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=100&offset=300

Other filters:

5 connector_name (if null ignore)

6 function_name (if null ignore)

7 correlation_id (if null ignore)

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

JSON response body fields:

connector_name:

correlation_id: 1flssoftxq0cr1nssr68u0mioj

date: 2020-01-27

duration: 5.123

function_name:

metrics:

","operationId":"OBPv2.2.0-getConnectorMetrics","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ConnectorMetricsJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidDateFormat"}}}}},"/obp/v2.2.0/management/consumers":{"get":{"tags":["Consumer","Old-Style"],"summary":"Get Consumers","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get the all Consumers.

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

JSON response body fields:

app_name: appNameBank

app_type: Web

consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

created:

created_by_user:

created_by_user_id:

description: Description of the object. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: false

list:

provider: ETHEREUM

provider_id:

redirect_url: https://apisandbox.openbankproject.com

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

","operationId":"OBPv2.1.0-getConsumers","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ConsumersJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Consumer","Old-Style"],"summary":"Post a Consumer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create a Consumer (Authenticated access).

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

JSON request body fields:

app_name: appNameBank

app_type: Web

clientCertificate: clientCertificate

created:

created_by_user_id:

description: Description of the object. Maximum length is 2000. It can be any characters here.

developer_email:

enabled: false

redirect_url: https://apisandbox.openbankproject.com

JSON response body fields:

app_name: appNameBank

app_type: Web

clientCertificate: clientCertificate

created:

created_by_user_id:

description: Description of the object. Maximum length is 2000. It can be any characters here.

developer_email:

enabled: false

redirect_url: https://apisandbox.openbankproject.com

","operationId":"OBPv2.2.0-createConsumer","parameters":[{"in":"body","name":"body","description":"ConsumerPostJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ConsumerPostJSON"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/ConsumerPostJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/management/consumers/{CONSUMER_ID}":{"get":{"tags":["Consumer","Old-Style"],"summary":"Get Consumer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get the Consumer specified by CONSUMER_ID.

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

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

app_name: appNameBank

app_type: Web

consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

created:

created_by_user:

created_by_user_id:

description: Description of the object. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: false

provider: ETHEREUM

provider_id:

redirect_url: https://apisandbox.openbankproject.com

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

","operationId":"OBPv2.1.0-getConsumer","parameters":[{"in":"path","name":"CONSUMER_ID","description":"new consumer id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ConsumerJsonV210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Consumer","Old-Style"],"summary":"Enable or Disable Consumers","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Enable/Disable a Consumer specified by CONSUMER_ID.

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

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

enabled: false

","operationId":"OBPv2.1.0-enableDisableConsumers","parameters":[{"in":"body","name":"body","description":"PutEnabledJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PutEnabledJSON"}},{"in":"path","name":"CONSUMER_ID","description":"new consumer id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/PutEnabledJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/management/consumers/{CONSUMER_ID}/consumer/redirect_url":{"put":{"tags":["Consumer"],"summary":"Update Consumer RedirectUrl","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update an existing redirectUrl for a Consumer specified by CONSUMER_ID.

CONSUMER_ID can be obtained after you register the application.

Or use the endpoint 'Get Consumers' to get it

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

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

app_name: appNameBank

app_type: Web

consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

created:

created_by_user:

created_by_user_id:

description: Description of the object. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: false

provider: ETHEREUM

provider_id:

redirect_url: https://apisandbox.openbankproject.com

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

","operationId":"OBPv2.1.0-updateConsumerRedirectUrl","parameters":[{"in":"body","name":"body","description":"ConsumerRedirectUrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ConsumerRedirectUrlJSON"}},{"in":"path","name":"CONSUMER_ID","description":"new consumer id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ConsumerJsonV210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/management/metrics":{"get":{"tags":["Metric","API"],"summary":"Get Metrics","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get the all metrics

require CanReadMetrics role

Filters Part 1.filtering (no wilde cards etc.) parameters to GET /management/metrics

Should be able to filter on the following metrics fields

eg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2

1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z

2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z

3 limit (for pagination: defaults to 50) eg:limit=200

4 offset (for pagination: zero index, defaults to 0) eg: offset=10

5 sort_by (defaults to date field) eg: sort_by=date
possible values:
"url",
"date",
"username" (or "user_name" for backward compatibility),
"app_name",
"developer_email",
"implemented_by_partial_function",
"implemented_in_version",
"consumer_id",
"verb"

6 direction (defaults to date desc) eg: direction=desc

eg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&username=susan.uk.29@example.com&consumer_id=78

Other filters:

7 consumer_id (if null ignore)

8 user_id (if null ignore)

9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)

10 url (if null ignore), note: can not contain '&'.

11 app_name (if null ignore)

12 implemented_by_partial_function (if null ignore),

13 implemented_in_version (if null ignore)

14 verb (if null ignore)

15 correlation_id (if null ignore)

16 duration (if null ignore) non digit chars will be silently omitted

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

JSON response body fields:

app_name: appNameBank

consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

correlation_id: 1flssoftxq0cr1nssr68u0mioj

date: 2020-01-27

developer_email:

duration: 5.123

implemented_by_partial_function:

implemented_in_version:

metrics:

url: http://www.example.com/id-docs/123/image.png

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

user_name: felixsmith

verb:

","operationId":"OBPv2.1.0-getMetrics","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/MetricsJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/message-docs/CONNECTOR":{"get":{"tags":["Message-Doc","Documentation","API"],"summary":"Get Message Docs","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

These message docs provide example messages sent by OBP to the (RabbitMq) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes.
Integrators can use these messages to build Adapters that provide core banking services to OBP.

Note: API Explorer provides a Message Docs page where these messages are displayed.

CONNECTOR: rest_vMar2019, stored_procedure_vDec2019 ...

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

URL Parameters:

CONNECTOR: CONNECTOR

JSON response body fields:

adapter_implementation:

dependent_endpoints:

description: Description of the object. Maximum length is 2000. It can be any characters here.

example_inbound_message: {}

example_outbound_message: {}

group:

message_docs:

message_format:

name: ACCOUNT_MANAGEMENT_FEE

process: obp.getBank

suggested_order:

version:

inboundAvroSchema:

inbound_topic:

outboundAvroSchema:

outbound_topic:

requiredFieldInfo: false

","operationId":"OBPv2.2.0-getMessageDocs","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/MessageDocsJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidConnector"}}}}},"/obp/v2.2.0/my/accounts":{"get":{"tags":["Account","PrivateData","PSD2","Old-Style"],"summary":"Get Accounts at all Banks (Private)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get private accounts at all banks (Authenticated access)
Returns the list of accounts containing private views for the user at all banks.
For each account the API returns the ID and the available views.

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

JSON response body fields:

_links: _links

accounts:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

","operationId":"OBPv2.0.0-corePrivateAccountsAllBanks","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CoreAccountsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v2.2.0/my/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/account":{"get":{"tags":["Account","PSD2","Old-Style"],"summary":"Get Account by Id (Core)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Information returned about the account specified by ACCOUNT_ID:

This call returns the owner view and requires access to that view.

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

BANK_ID: gh.29.uk

JSON response body fields:

IBAN: DE91 1000 0000 0123 4567 89

account_routing:

address:

amount: 10.12

balance: 10

bank_id: gh.29.uk

currency: EUR

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

number:

owners:

provider: ETHEREUM

scheme: OBP

swift_bic:

type:

","operationId":"OBPv2.0.0-getCoreAccountById","parameters":[{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ModeratedCoreAccountJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v2.2.0/roles":{"get":{"tags":["Role"],"summary":"Get Roles","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns all available roles

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

JSON response body fields:

requires_bank_id:

role:

roles: CanCreateMyUser

","operationId":"OBPv2.1.0-getRoles","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AvailableRolesJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/root":{"get":{"tags":["API"],"summary":"Get API Info (root)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns information about:

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

JSON response body fields:

connector: connector

email: felixsmith@example.com

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

hosted_by:

organisation:

organisation_website:

phone:

version:

version_status:

","operationId":"OBPv2.2.0-root","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/APIInfoJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v2.2.0/sandbox/data-import":{"post":{"tags":["Sandbox"],"summary":"Create sandbox","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Import bulk data into the sandbox (Authenticated access).

This call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.

The user needs to have CanCreateSandbox entitlement.

Note: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.

An example of an import set of data (json) can be found here
User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

IBAN: DE91 1000 0000 0123 4567 89

accounts:

actual_date: 2020-01-27

address:

amount: 10.12

atms:

balance: 10

bank:

bank_id: gh.29.uk

banks:

branches:

category:

channel:

city:

code: 125

completed: 2020-01-27

country_code: 1254

county:

crm_events:

currency: EUR

customer:

description: Description of the object. Maximum length is 2000. It can be any characters here.

detail:

details:

email: felixsmith@example.com

family:

full_name: full name string

generate_accountants_view:

generate_auditors_view:

generate_public_view:

hours:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

latitude: 38.8951

license:

line_1:

line_2:

line_3:

location:

logo: logo url

longitude: -77.0364

meta:

more_info_url: www.example.com/abc

name: ACCOUNT_MANAGEMENT_FEE

new_balance: 20

number:

owners:

password: passwordpasswordpassword

post_code: 789

posted: 2020-01-27

products:

short_name:

state:

super_family:

this_account:

transactions:

type:

user_name: felixsmith

users: user list

value: 5987953

website: www.openbankproject.com

account_number: 546387432

counterparty:

driveUp:

lobby:

name: ACCOUNT_MANAGEMENT_FEE

JSON response body fields:

success:

","operationId":"OBPv2.1.0-sandboxDataImport","parameters":[{"in":"body","name":"body","description":"SandboxDataImport object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/SandboxDataImport"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/search/metrics":{"get":{"tags":["Metric","API","Old-Style"],"summary":"Search API Metrics via Elasticsearch","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Search the API calls made to this API instance via Elastic Search.

Login is required.

CanSearchMetrics entitlement is required to search metrics data.

parameters:

esType - elasticsearch type

simple query:

q - plain_text_query

df - default field to search

sort - field to sort on

size - number of hits returned, default 10

from - show hits starting from

json query:

source - JSON_query_(URL-escaped)

example usage:

/search/metrics/q=findThis

or:

/search/metrics/source={"query":{"query_string":{"query":"findThis"}}}

Note!!

The whole JSON query string MUST be URL-encoded:

etc..

Only q, source and esType are passed to Elastic

Elastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html

Elastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html

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

JSON response body fields:

none:

","operationId":"OBPv2.0.0-elasticSearchMetrics","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EmptyElasticSearch"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/search/warehouse":{"get":{"tags":["Data-Warehouse","Old-Style"],"summary":"Search Warehouse Data Via Elasticsearch","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Search warehouse data via Elastic Search.

Login is required.

CanSearchWarehouse entitlement is required to search warehouse data!

Send your email, name, project name and user_id to the admins to get access.

Elastic (search) is used in the background. See links below for syntax.

parameters:

esType - elasticsearch type

simple query:

q - plain_text_query

df - default field to search

sort - field to sort on

size - number of hits returned, default 10

from - show hits starting from

json query:

source - JSON_query_(URL-escaped)

Example usage:

GET /search/warehouse/q=findThis

or:

GET /search/warehouse/source={"query":{"query_string":{"query":"findThis"}}}

Note!!

The whole JSON query string MUST be URL-encoded:

etc..

Only q, source and esType are passed to Elastic

Elastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html

Elastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html

You can specify the esType thus: /search/warehouse/esType=type&q=a

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

JSON response body fields:

none:

","operationId":"OBPv2.0.0-elasticSearchWarehouse","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EmptyElasticSearch"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/users":{"get":{"tags":["User"],"summary":"Get all Users","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get all users

Login is required.
CanGetAnyUser entitlement is required,

Possible custom url parameters for pagination:

eg1:?limit=100&offset=0

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

JSON response body fields:

bank_id: gh.29.uk

email: felixsmith@example.com

entitlement_id:

entitlements:

list:

provider: ETHEREUM

provider_id:

role_name:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

users: user list

","operationId":"OBPv2.1.0-getUsers","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/UsersJsonV200"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["User","Onboarding"],"summary":"Create User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Creates OBP user.
No authorisation required.

Mimics current webform to Register.

Requires username(email), password, first_name, last_name, and email.

Validation checks performed:
- Password must meet strong password requirements (InvalidStrongPasswordFormat error if not)
- Username must be unique (409 error if username already exists)
- All required fields must be present in valid JSON format

Email validation behavior:
- Controlled by property 'authUser.skipEmailValidation' (default: false)
- When false: User is created with validated=false and a validation email is sent to the user's email address
- When true: User is created with validated=true and no validation email is sent
- Default entitlements are granted immediately regardless of validation status

Note: If email validation is required (skipEmailValidation=false), the user must click the validation link
in the email before they can log in, even though entitlements are already granted.

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

JSON request body fields:

email: felixsmith@example.com

first_name: Tom

last_name: Smith

password: passwordpasswordpassword

username: felixsmith

JSON response body fields:

bank_id: gh.29.uk

email: felixsmith@example.com

entitlement_id:

entitlements:

list:

provider: ETHEREUM

provider_id:

role_name:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

","operationId":"OBPv2.0.0-createUser","parameters":[{"in":"body","name":"body","description":"CreateUserJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateUserJson"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/UserJsonV200"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/users/{USER_EMAIL}":{"get":{"tags":["User","Old-Style"],"summary":"Get Users by Email Address","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get users by email address

Login is required.
CanGetAnyUser entitlement is required,

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

URL Parameters:

USER_EMAIL: USER_EMAIL

JSON response body fields:

bank_id: gh.29.uk

email: felixsmith@example.com

entitlement_id:

entitlements:

list:

provider: ETHEREUM

provider_id:

role_name:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

users: user list

","operationId":"OBPv2.0.0-getUser","parameters":[{"in":"path","name":"USER_EMAIL","description":"The user email id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/UsersJsonV200"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/users/{USER_ID}/entitlement/{ENTITLEMENT_ID}":{"delete":{"tags":["Role","User","Entitlement"],"summary":"Delete Entitlement","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete Entitlement specified by ENTITLEMENT_ID for an user specified by USER_ID

Authentication is required and the user needs to be a Super Admin.
Super Admins are listed in the Props file.

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

URL Parameters:

ENTITLEMENT_ID:

USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

JSON response body fields:

","operationId":"OBPv2.0.0-deleteEntitlement","parameters":[{"in":"path","name":"ENTITLEMENT_ID","description":"The entitblement id","required":true,"type":"string"},{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/users/{USER_ID}/entitlements":{"get":{"tags":["Role","Entitlement","User","Old-Style"],"summary":"Get Entitlements for User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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

URL Parameters:

USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

JSON response body fields:

bank_id: gh.29.uk

entitlement_id:

list:

role_name:

","operationId":"OBPv2.0.0-getEntitlements","parameters":[{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EntitlementJSONs"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Role","Entitlement","User"],"summary":"Add Entitlement for a User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create Entitlement. Grant Role to User.

Entitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)

For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""

For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"

Authentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.

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

URL Parameters:

USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

JSON request body fields:

bank_id: gh.29.uk

role_name:

JSON response body fields:

bank_id: gh.29.uk

entitlement_id:

role_name:

","operationId":"OBPv2.0.0-addEntitlement","parameters":[{"in":"body","name":"body","description":"CreateEntitlementJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateEntitlementJSON"}},{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/EntitlementJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v2.2.0/users/current":{"get":{"tags":["User","Old-Style"],"summary":"Get User (Current)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get the logged in user

Login is required.

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

JSON response body fields:

bank_id: gh.29.uk

email: felixsmith@example.com

entitlement_id:

entitlements:

list:

provider: ETHEREUM

provider_id:

role_name:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

","operationId":"OBPv2.0.0-getCurrentUser","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/UserJsonV200"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}}},"definitions":{"ErrorInvalidJsonFormat":{"properties":{"message":{"type":"string","example":"OBP-10001: Incorrect json format."}}},"ErrorInvalidISOCurrencyCode":{"properties":{"message":{"type":"string","example":"OBP-10003: Invalid Currency Value. Expected a 3-letter ISO Currency Code (e.g., 'USD', 'EUR'), 'lovelace' (Cardano), or 'ETH' (Ethereum). Refer to ISO 4217 currency codes: https://www.iso.org/iso-4217-currency-codes.html"}}},"ErrorInvalidDateFormat":{"properties":{"message":{"type":"string","example":"OBP-10005: Invalid Date Format. Could not convert value to a Date."}}},"ErrorInvalidApiVersionString":{"properties":{"message":{"type":"string","example":"OBP-00027: Invalid API Version string. We could not find the version specified."}}},"ErrorAuthenticatedUserIsRequired":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ErrorBankNotFound":{"properties":{"message":{"type":"string","example":"OBP-30001: Bank not found. Please specify a valid value for BANK_ID."}}},"ErrorBranchNotFoundByBranchId":{"properties":{"message":{"type":"string","example":"OBP-300010: Branch not found. Please specify a valid value for BRANCH_ID. Or License may not be set. meta.license.id and meta.license.name can not be empty"}}},"ErrorProductNotFoundByProductCode":{"properties":{"message":{"type":"string","example":"OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE."}}},"ErrorBankAccountNotFound":{"properties":{"message":{"type":"string","example":"OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. "}}},"ErrorNoViewPermission":{"properties":{"message":{"type":"string","example":"OBP-30022: The current view does not have the permission:"}}},"ErrorCannotGetAccounts":{"properties":{"message":{"type":"string","example":"OBP-30066: Could not get accounts."}}},"ErrorInvalidConnector":{"properties":{"message":{"type":"string","example":"OBP-30211: Invalid Connector. Please specify a valid value for CONNECTOR."}}},"ErrorUnknownError":{"properties":{"message":{"type":"string","example":"OBP-50000: Unknown Error."}}},"MoreInfoJSON":{"required":["more_info"],"properties":{"more_info":{"type":"string","example":"String"}}},"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"}}}},"PostCounterpartyJSON":{"required":["other_account_routing_address","other_account_routing_scheme","name","other_account_secondary_routing_address","is_beneficiary","description","other_branch_routing_address","bespoke","other_bank_routing_scheme","other_branch_routing_scheme","other_bank_routing_address","other_account_secondary_routing_scheme"],"properties":{"other_account_routing_address":{"type":"string","example":"DE89370400440532013000"},"other_account_routing_scheme":{"type":"string","example":"IBAN"},"name":{"type":"string","example":"CounterpartyName"},"other_account_secondary_routing_address":{"type":"string","example":"DE89370400440532013000"},"is_beneficiary":{"type":"boolean","example":"true"},"description":{"type":"string","example":"My landlord"},"other_branch_routing_address":{"type":"string","example":"12f8a9e6-c2b1-407a-8bd0-421b7119307e"},"bespoke":{"type":"array","items":{"$ref":"#/definitions/PostCounterpartyBespokeJson"}},"other_bank_routing_scheme":{"type":"string","example":"OBP"},"other_branch_routing_scheme":{"type":"string","example":"OBP"},"other_bank_routing_address":{"type":"string","example":"gh.29.uk"},"other_account_secondary_routing_scheme":{"type":"string","example":"IBAN"}}},"ImageUrlJSON":{"required":["image_URL"],"properties":{"image_URL":{"type":"string","example":"String"}}},"CorporateLocationJSON":{"required":["corporate_location"],"properties":{"corporate_location":{"$ref":"#/definitions/LocationPlainJSON"}}},"PostTransactionWhereJSON":{"required":["where"],"properties":{"where":{"$ref":"#/definitions/LocationPlainJSON"}}},"PostKycCheckJSON":{"required":["customer_number","how","date","satisfied","staff_user_id","staff_name","comments"],"properties":{"customer_number":{"type":"string","example":"5987953"},"how":{"type":"string","example":"online_meeting"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"satisfied":{"type":"boolean","example":"true"},"staff_user_id":{"type":"string","example":"67876"},"staff_name":{"type":"string","example":"Simon"},"comments":{"type":"string","example":"String"}}},"PostKycStatusJSON":{"required":["customer_number","ok","date"],"properties":{"customer_number":{"type":"string","example":"5987953"},"ok":{"type":"boolean","example":"true"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"PostKycDocumentJSON":{"required":["number","customer_number","issue_date","type","issue_place","expiry_date"],"properties":{"number":{"type":"string","example":"12345"},"customer_number":{"type":"string","example":"5987953"},"issue_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"type":{"type":"string","example":"passport"},"issue_place":{"type":"string","example":"Berlin"},"expiry_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"AtmJsonV220":{"required":["name","location","bank_id","id","meta","address"],"properties":{"name":{"type":"string","example":"OBP"},"location":{"$ref":"#/definitions/LocationJsonV140"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"123"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"address":{"$ref":"#/definitions/AddressJsonV140"}}},"ProductJsonV220":{"required":["name","description","more_info_url","super_family","code","bank_id","meta","details","category","family"],"properties":{"name":{"type":"string","example":"product name"},"description":{"type":"string","example":"Description"},"more_info_url":{"type":"string","example":"www.example.com/prod1/more-info.html"},"super_family":{"type":"string","example":"super family"},"code":{"type":"string","example":"prod1"},"bank_id":{"type":"string","example":"gh.29.uk"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"details":{"type":"string","example":"Details"},"category":{"type":"string","example":"category"},"family":{"type":"string","example":"family"}}},"AliasJSON":{"required":["alias"],"properties":{"alias":{"type":"string","example":"String"}}},"BranchJsonPutV210":{"required":["name","location","drive_up","bank_id","meta","lobby","address"],"properties":{"name":{"type":"string","example":"OBP"},"location":{"$ref":"#/definitions/LocationJsonV140"},"drive_up":{"$ref":"#/definitions/DriveUpStringJson"},"bank_id":{"type":"string","example":"gh.29.fi"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"lobby":{"$ref":"#/definitions/LobbyStringJson"},"address":{"$ref":"#/definitions/AddressJsonV140"}}},"PostTransactionTagJSON":{"required":["value"],"properties":{"value":{"type":"string","example":"String"}}},"UrlJSON":{"required":["URL"],"properties":{"URL":{"type":"string","example":"String"}}},"BranchJsonV220":{"required":["name","location","branch_routing","drive_up","bank_id","id","meta","lobby","address"],"properties":{"name":{"type":"string","example":"OBP"},"location":{"$ref":"#/definitions/LocationJsonV140"},"branch_routing":{"$ref":"#/definitions/BranchRoutingJsonV141"},"drive_up":{"$ref":"#/definitions/DriveUpStringJson"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"123"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"lobby":{"$ref":"#/definitions/LobbyStringJson"},"address":{"$ref":"#/definitions/AddressJsonV140"}}},"UpdateViewJsonV121":{"required":["description","is_public","hide_metadata_if_alias_used","which_alias_to_use","allowed_actions"],"properties":{"description":{"type":"string","example":"This view is for family"},"is_public":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"false"},"which_alias_to_use":{"type":"string","example":"family"},"allowed_actions":{"type":"array","items":{"type":"string"}}}},"TransactionRequestBodySEPAJSON":{"required":["description","to","charge_policy","value"],"properties":{"description":{"type":"string","example":"This is a SEPA Transaction Request"},"future_date":{"type":"string","example":"20200127"},"to":{"$ref":"#/definitions/IbanJson"},"charge_policy":{"type":"string","example":"SHARED"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"OpenCorporateUrlJSON":{"required":["open_corporates_URL"],"properties":{"open_corporates_URL":{"type":"string","example":"String"}}},"TransactionNarrativeJSON":{"required":["narrative"],"properties":{"narrative":{"type":"string","example":"narative"}}},"PostKycMediaJSON":{"required":["url","customer_number","date","relates_to_kyc_document_id","relates_to_kyc_check_id","type"],"properties":{"url":{"type":"string","example":"http://www.example.com/id-docs/123/image.png"},"customer_number":{"type":"string","example":"5987953"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"relates_to_kyc_document_id":{"type":"string","example":"123"},"relates_to_kyc_check_id":{"type":"string","example":"123"},"type":{"type":"string","example":"image"}}},"CreateViewJsonV121":{"required":["name","description","is_public","hide_metadata_if_alias_used","which_alias_to_use","allowed_actions"],"properties":{"name":{"type":"string","example":"_test"},"description":{"type":"string","example":"This view is for family"},"is_public":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"false"},"which_alias_to_use":{"type":"string","example":"family"},"allowed_actions":{"type":"array","items":{"type":"string"}}}},"ConsumerPostJSON":{"required":["created_by_user_id","app_type","description","enabled","redirect_url","developer_email","clientCertificate","app_name","created"],"properties":{"created_by_user_id":{"type":"string","example":"createdby"},"app_type":{"type":"string","example":"Test"},"description":{"type":"string","example":"Description"},"enabled":{"type":"boolean","example":"true"},"redirect_url":{"type":"string","example":"redirecturl"},"developer_email":{"type":"string","example":"some@email.com"},"clientCertificate":{"type":"string","example":"-----BEGIN CERTIFICATE-----\nclient_certificate_content\n-----END CERTIFICATE-----"},"app_name":{"type":"string","example":"Test"},"created":{"type":"string","format":"date","example":"2026-04-15T13:57:28Z"}}},"PostCustomerJsonV210":{"required":["email","mobile_phone_number","customer_number","highest_education_attained","user_id","dob_of_dependants","date_of_birth","credit_rating","last_ok_date","employment_status","legal_name","credit_limit","face_image","dependants","relationship_status","kyc_status"],"properties":{"email":{"type":"string","example":"felixsmith@example.com"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"5987953"},"highest_education_attained":{"type":"string","example":"Master"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"date_of_birth":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"2025-04-15T13:57:28Z"},"employment_status":{"type":"string","example":"worker"},"legal_name":{"type":"string","example":"Eveline Tripman"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"},"kyc_status":{"type":"boolean","example":"false"}}},"PhysicalLocationJSON":{"required":["physical_location"],"properties":{"physical_location":{"$ref":"#/definitions/LocationPlainJSON"}}},"CreateEntitlementJSON":{"required":["bank_id","role_name"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"role_name":{"type":"string","example":"CanCreateBranch"}}},"CreateUserCustomerLinkJson":{"required":["user_id","customer_id"],"properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"SocialMediaJSON":{"required":["date_activated","customer_number","date_added","type","handle"],"properties":{"date_activated":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"customer_number":{"type":"string","example":"5987953"},"date_added":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"type":{"type":"string","example":"PlaceholderString"},"handle":{"type":"string","example":"PlaceholderString"}}},"CreateAccountJSONV220":{"required":["account_routing","branch_id","label","balance","user_id","type"],"properties":{"account_routing":{"$ref":"#/definitions/AccountRoutingJsonV121"},"branch_id":{"type":"string","example":"1234"},"label":{"type":"string","example":"Label"},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"type":{"type":"string","example":"CURRENT"}}},"ChallengeAnswerJSON":{"required":["id","answer"],"properties":{"id":{"type":"string","example":"This is challenge.id, you can get it from `Create Transaction Request.` response, only is useful if status ==`INITIATED` there."},"answer":{"type":"string","example":"123"}}},"TransactionTypeJsonV200":{"required":["description","short_code","bank_id","id","charge","summary"],"properties":{"description":{"type":"string","example":"PlaceholderString"},"short_code":{"type":"string","example":"PlaceholderString"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"$ref":"#/definitions/TransactionTypeId"},"charge":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"summary":{"type":"string","example":"PlaceholderString"}}},"AddCustomerMessageJson":{"required":["message","from_department","from_person"],"properties":{"message":{"type":"string","example":"String"},"from_department":{"type":"string","example":"String"},"from_person":{"type":"string","example":"String"}}},"TransactionRequestBodyFreeFormJSON":{"required":["value","description"],"properties":{"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"This is a FREE_FORM Transaction Request"}}},"PostTransactionCommentJSON":{"required":["value"],"properties":{"value":{"type":"string","example":"String"}}},"CreateUserJson":{"required":["first_name","email","username","last_name","password"],"properties":{"first_name":{"type":"string","example":"Simon"},"email":{"type":"string","example":"felixsmith@example.com"},"username":{"type":"string","example":"felixsmith"},"last_name":{"type":"string","example":"Redfern"},"password":{"type":"string","example":"String"}}},"TransactionRequestBodyJsonV200":{"required":["to","value","description"],"properties":{"to":{"$ref":"#/definitions/TransactionRequestAccountJsonV140"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"this is for work"}}},"BankJSONV220":{"required":["national_identifier","full_name","swift_bic","logo_url","id","short_name","bank_routing","website_url"],"properties":{"national_identifier":{"type":"string","example":"UK97ZZZ1234567890"},"full_name":{"type":"string","example":"uk"},"swift_bic":{"type":"string","example":"IIIGGB22"},"logo_url":{"type":"string","example":"https://static.openbankproject.com/images/sandbox/bank_x.png"},"id":{"type":"string","example":"gh.29.uk.x"},"short_name":{"type":"string","example":"uk"},"bank_routing":{"$ref":"#/definitions/BankRoutingJsonV121"},"website_url":{"type":"string","example":"https://www.example.com"}}},"UpdateAccountJSON":{"required":["id","label","bank_id"],"properties":{"id":{"type":"string","example":"123123"},"label":{"type":"string","example":"label"},"bank_id":{"type":"string","example":"gh.29.uk"}}},"ViewIdsJson":{"required":["views"],"properties":{"views":{"type":"array","items":{"type":"string"}}}},"PostTransactionImageJSON":{"required":["label","URL"],"properties":{"label":{"type":"string","example":"String"},"URL":{"type":"string","example":"String"}}},"PostPhysicalCardJSON":{"required":["allows","expires_date","networks","issue_number","replacement","enabled","collected","technology","account_id","pin_reset","serial_number","valid_from_date","bank_card_number","name_on_card","posted"],"properties":{"allows":{"type":"array","items":{"type":"string"}},"expires_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"networks":{"type":"array","items":{"type":"string"}},"issue_number":{"type":"string","example":"1"},"replacement":{"$ref":"#/definitions/ReplacementJSON"},"enabled":{"type":"boolean","example":"true"},"collected":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"technology":{"type":"string","example":"technology"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"pin_reset":{"type":"array","items":{"$ref":"#/definitions/PinResetJSON"}},"serial_number":{"type":"string","example":"1324234"},"valid_from_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"bank_card_number":{"type":"string","example":"364435172576215"},"name_on_card":{"type":"string","example":"name_on_card"},"posted":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"PutEnabledJSON":{"required":["enabled"],"properties":{"enabled":{"type":"boolean","example":"false"}}},"ConsumerRedirectUrlJSON":{"required":["redirect_url"],"properties":{"redirect_url":{"type":"string","example":"http://localhost:8888"}}},"SandboxDataImport":{"required":["crm_events","users","products","banks","branches","transactions","accounts","atms"],"properties":{"crm_events":{"type":"array","items":{"$ref":"#/definitions/SandboxCrmEventImport"}},"users":{"type":"array","items":{"$ref":"#/definitions/SandboxUserImport"}},"products":{"type":"array","items":{"$ref":"#/definitions/SandboxProductImport"}},"banks":{"type":"array","items":{"$ref":"#/definitions/SandboxBankImport"}},"branches":{"type":"array","items":{"$ref":"#/definitions/SandboxBranchImport"}},"transactions":{"type":"array","items":{"$ref":"#/definitions/SandboxTransactionImport"}},"accounts":{"type":"array","items":{"$ref":"#/definitions/SandboxAccountImport"}},"atms":{"type":"array","items":{"$ref":"#/definitions/SandboxAtmImport"}}}},"TransactionRequestBodyCounterpartyJSON":{"required":["description","to","charge_policy","value"],"properties":{"description":{"type":"string","example":"A description for the transaction to the counterparty"},"future_date":{"type":"string","example":"20200127"},"attributes":{"type":"array","items":{"$ref":"#/definitions/TransactionRequestAttributeJsonV400"}},"to":{"$ref":"#/definitions/CounterpartyIdJson"},"charge_policy":{"type":"string","example":"SHARED"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"CounterpartyWithMetadataJson":{"required":["other_account_routing_address","other_account_routing_scheme","created_by_user_id","name","other_account_secondary_routing_address","is_beneficiary","description","other_branch_routing_address","bespoke","other_bank_routing_scheme","other_branch_routing_scheme","this_account_id","this_view_id","metadata","other_bank_routing_address","this_bank_id","counterparty_id","other_account_secondary_routing_scheme"],"properties":{"other_account_routing_address":{"type":"string","example":"DE89370400440532013000"},"other_account_routing_scheme":{"type":"string","example":"IBAN"},"created_by_user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"name":{"type":"string","example":"CounterpartyName"},"other_account_secondary_routing_address":{"type":"string","example":"DE89370400440532013000"},"is_beneficiary":{"type":"boolean","example":"true"},"description":{"type":"string","example":"My landlord"},"other_branch_routing_address":{"type":"string","example":"12f8a9e6-c2b1-407a-8bd0-421b7119307e"},"bespoke":{"type":"array","items":{"$ref":"#/definitions/PostCounterpartyBespokeJson"}},"other_bank_routing_scheme":{"type":"string","example":"OBP"},"other_branch_routing_scheme":{"type":"string","example":"OBP"},"this_account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"this_view_id":{"type":"string","example":"owner"},"metadata":{"$ref":"#/definitions/CounterpartyMetadataJson"},"other_bank_routing_address":{"type":"string","example":"gh.29.uk"},"this_bank_id":{"type":"string","example":"gh.29.uk"},"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"other_account_secondary_routing_scheme":{"type":"string","example":"IBAN"}}},"BasicAccountsJSON":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/BasicAccountJSON"}}}},"CoreAccountsJSON":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/CoreAccountJSON"}}}},"ViewsJSONV121":{"required":["views"],"properties":{"views":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}}}},"SuccessMessage":{"required":["success"],"properties":{"success":{"type":"string","example":"Success"}}},"OtherAccountJSON":{"required":["number","IBAN","swift_bic","holder","bank","id","metadata","kind"],"properties":{"number":{"type":"string","example":"123"},"IBAN":{"type":"string","example":"UK234DB"},"swift_bic":{"type":"string","example":"UK12321DB"},"holder":{"$ref":"#/definitions/AccountHolderJSON"},"bank":{"$ref":"#/definitions/MinimalBankJSON"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"metadata":{"$ref":"#/definitions/OtherAccountMetadataJSON"},"kind":{"type":"string","example":"3456"}}},"APIInfoJSON":{"required":["version_status","version","connector","hosted_by","git_commit"],"properties":{"version_status":{"type":"string","example":"String"},"version":{"type":"string","example":"String"},"connector":{"type":"string","example":"String"},"hosted_by":{"$ref":"#/definitions/HostedBy"},"git_commit":{"type":"string","example":"String"}}},"CounterpartiesJsonV220":{"required":["counterparties"],"properties":{"counterparties":{"type":"array","items":{"$ref":"#/definitions/CounterpartyJsonV220"}}}},"CustomerMessagesJson":{"required":["messages"],"properties":{"messages":{"type":"array","items":{"$ref":"#/definitions/CustomerMessageJson"}}}},"EntitlementJSONs":{"required":["list"],"properties":{"list":{"type":"array","items":{"$ref":"#/definitions/EntitlementJSON"}}}},"EmptyElasticSearch":{"properties":{"none":{"type":"string"}}},"KycStatusesJSON":{"required":["statuses"],"properties":{"statuses":{"type":"array","items":{"$ref":"#/definitions/KycStatusJSON"}}}},"UsersJsonV200":{"required":["users"],"properties":{"users":{"type":"array","items":{"$ref":"#/definitions/UserJsonV200"}}}},"KycCheckJSON":{"required":["customer_id","customer_number","bank_id","id","how","date","satisfied","staff_user_id","staff_name","comments"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"customer_number":{"type":"string","example":"5987953"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"PlaceholderString"},"how":{"type":"string","example":"PlaceholderString"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"satisfied":{"type":"boolean","example":"true"},"staff_user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"staff_name":{"type":"string","example":"PlaceholderString"},"comments":{"type":"string","example":"PlaceholderString"}}},"ProductJsonV210":{"required":["name","description","more_info_url","super_family","code","bank_id","meta","details","category","family"],"properties":{"name":{"type":"string","example":"product name"},"description":{"type":"string","example":"Description"},"more_info_url":{"type":"string","example":"www.example.com/prod1/more-info.html"},"super_family":{"type":"string","example":"super family"},"code":{"type":"string","example":"prod1"},"bank_id":{"type":"string","example":"bankid123"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"details":{"type":"string","example":"Details"},"category":{"type":"string","example":"category"},"family":{"type":"string","example":"family"}}},"KycStatusJSON":{"required":["customer_id","customer_number","ok","date"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"customer_number":{"type":"string","example":"5987953"},"ok":{"type":"boolean","example":"true"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"KycDocumentJSON":{"required":["number","customer_id","customer_number","issue_date","bank_id","id","type","issue_place","expiry_date"],"properties":{"number":{"type":"string","example":"PlaceholderString"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"customer_number":{"type":"string","example":"5987953"},"issue_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"PlaceholderString"},"type":{"type":"string","example":"PlaceholderString"},"issue_place":{"type":"string","example":"PlaceholderString"},"expiry_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"OtherAccountsJSON":{"required":["other_accounts"],"properties":{"other_accounts":{"type":"array","items":{"$ref":"#/definitions/OtherAccountJSON"}}}},"BankJSON":{"required":["website","full_name","logo","id","short_name","bank_routing"],"properties":{"website":{"type":"string","example":"www.openbankproject.com"},"full_name":{"type":"string","example":"full_name"},"logo":{"type":"string","example":"logo"},"id":{"type":"string","example":"gh.29.uk"},"short_name":{"type":"string","example":"short_name "},"bank_routing":{"$ref":"#/definitions/BankRoutingJsonV121"}}},"BanksJSON":{"required":["banks"],"properties":{"banks":{"type":"array","items":{"$ref":"#/definitions/BankJSON"}}}},"PhysicalCardsJSON":{"required":["cards"],"properties":{"cards":{"type":"array","items":{"$ref":"#/definitions/PhysicalCardJSON"}}}},"TransactionWhereJSON":{"required":["where"],"properties":{"where":{"$ref":"#/definitions/LocationJSONV121"}}},"TransactionRequestTypesJSON":{"required":["transaction_request_types"],"properties":{"transaction_request_types":{"type":"array","items":{"$ref":"#/definitions/TransactionRequestTypeJSONV210"}}}},"BranchJson":{"required":["name","location","branch_routing","drive_up","id","meta","lobby","address"],"properties":{"name":{"type":"string","example":"String"},"location":{"$ref":"#/definitions/LocationJsonV140"},"branch_routing":{"$ref":"#/definitions/BranchRoutingJsonV141"},"drive_up":{"$ref":"#/definitions/DriveUpStringJson"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"lobby":{"$ref":"#/definitions/LobbyStringJson"},"address":{"$ref":"#/definitions/AddressJsonV140"}}},"CrmEventsJson":{"required":["crm_events"],"properties":{"crm_events":{"type":"array","items":{"$ref":"#/definitions/CrmEventJson"}}}},"TransactionCommentsJSON":{"required":["comments"],"properties":{"comments":{"type":"array","items":{"$ref":"#/definitions/TransactionCommentJSON"}}}},"TransactionTagJSON":{"required":["id","value","date","user"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"value":{"type":"string","example":"OBP"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"MetricsJson":{"required":["metrics"],"properties":{"metrics":{"type":"array","items":{"$ref":"#/definitions/MetricJson"}}}},"AtmJson":{"required":["name","location","id","meta","address"],"properties":{"name":{"type":"string","example":"String"},"location":{"$ref":"#/definitions/LocationJsonV140"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"address":{"$ref":"#/definitions/AddressJsonV140"}}},"ConfigurationJSON":{"required":["akka","elastic_search","cache","scopes"],"properties":{"akka":{"$ref":"#/definitions/AkkaJSON"},"elastic_search":{"$ref":"#/definitions/ElasticSearchJSON"},"cache":{"type":"array","items":{"$ref":"#/definitions/CachedFunctionJSON"}},"scopes":{"$ref":"#/definitions/ScopesJSON"}}},"ViewJSONV220":{"required":["can_see_transaction_start_date","can_add_url","can_add_where_tag","can_see_transaction_this_bank_account","can_see_bank_account_owners","can_see_private_alias","can_edit_owner_comment","can_see_other_account_national_identifier","can_see_public_alias","can_see_physical_location","can_see_owner_comment","can_see_bank_account_iban","can_see_corporate_location","can_see_bank_account_number","can_see_other_account_bank_name","description","can_see_transaction_other_bank_account","can_delete_corporate_location","can_see_comments","can_see_bank_account_bank_name","can_add_more_info","can_see_other_account_number","can_see_other_account_swift_bic","can_add_open_corporates_url","can_see_other_account_kind","can_delete_physical_location","can_see_bank_account_label","can_see_transaction_currency","is_public","can_see_transaction_finish_date","can_add_tag","can_see_images","can_see_bank_account_currency","hide_metadata_if_alias_used","can_delete_where_tag","alias","can_add_image_url","can_add_comment","can_see_image_url","id","can_see_bank_account_national_identifier","can_add_counterparty","can_see_tags","can_see_open_corporates_url","short_name","can_delete_tag","can_see_more_info","can_see_transaction_metadata","can_delete_comment","can_see_where_tag","can_add_private_alias","can_add_public_alias","can_see_bank_account_swift_bic","can_add_image","can_see_transaction_type","can_see_other_account_iban","can_add_physical_location","can_add_corporate_location","can_delete_image","can_see_url","can_see_bank_account_balance","can_see_transaction_balance","can_see_transaction_amount","can_see_other_account_metadata","can_see_bank_account_type","can_see_transaction_description"],"properties":{"can_see_transaction_start_date":{"type":"boolean","example":"true"},"can_add_url":{"type":"boolean","example":"true"},"can_add_where_tag":{"type":"boolean","example":"true"},"can_see_transaction_this_bank_account":{"type":"boolean","example":"true"},"can_see_bank_account_owners":{"type":"boolean","example":"true"},"can_see_private_alias":{"type":"boolean","example":"true"},"can_edit_owner_comment":{"type":"boolean","example":"true"},"can_see_other_account_national_identifier":{"type":"boolean","example":"true"},"can_see_public_alias":{"type":"boolean","example":"true"},"can_see_physical_location":{"type":"boolean","example":"true"},"can_see_owner_comment":{"type":"boolean","example":"true"},"can_see_bank_account_iban":{"type":"boolean","example":"true"},"can_see_corporate_location":{"type":"boolean","example":"true"},"can_see_bank_account_number":{"type":"boolean","example":"true"},"can_see_other_account_bank_name":{"type":"boolean","example":"true"},"description":{"type":"string","example":"description"},"can_see_transaction_other_bank_account":{"type":"boolean","example":"true"},"can_delete_corporate_location":{"type":"boolean","example":"true"},"can_see_comments":{"type":"boolean","example":"true"},"can_see_bank_account_bank_name":{"type":"boolean","example":"true"},"can_add_more_info":{"type":"boolean","example":"true"},"can_see_other_account_number":{"type":"boolean","example":"true"},"can_see_other_account_swift_bic":{"type":"boolean","example":"true"},"can_add_open_corporates_url":{"type":"boolean","example":"true"},"can_see_other_account_kind":{"type":"boolean","example":"true"},"can_delete_physical_location":{"type":"boolean","example":"true"},"can_see_bank_account_label":{"type":"boolean","example":"true"},"can_see_transaction_currency":{"type":"boolean","example":"true"},"is_public":{"type":"boolean","example":"true"},"can_see_transaction_finish_date":{"type":"boolean","example":"true"},"can_add_tag":{"type":"boolean","example":"true"},"can_see_images":{"type":"boolean","example":"true"},"can_see_bank_account_currency":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"true"},"can_delete_where_tag":{"type":"boolean","example":"true"},"alias":{"type":"string","example":"No"},"can_add_image_url":{"type":"boolean","example":"true"},"can_add_comment":{"type":"boolean","example":"true"},"can_see_image_url":{"type":"boolean","example":"true"},"id":{"type":"string","example":"1234"},"can_see_bank_account_national_identifier":{"type":"boolean","example":"true"},"can_add_counterparty":{"type":"boolean","example":"true"},"can_see_tags":{"type":"boolean","example":"true"},"can_see_open_corporates_url":{"type":"boolean","example":"true"},"short_name":{"type":"string","example":"short_name"},"can_delete_tag":{"type":"boolean","example":"true"},"can_see_more_info":{"type":"boolean","example":"true"},"can_see_transaction_metadata":{"type":"boolean","example":"true"},"can_delete_comment":{"type":"boolean","example":"true"},"can_see_where_tag":{"type":"boolean","example":"true"},"can_add_private_alias":{"type":"boolean","example":"true"},"can_add_public_alias":{"type":"boolean","example":"true"},"can_see_bank_account_swift_bic":{"type":"boolean","example":"true"},"can_add_image":{"type":"boolean","example":"true"},"can_see_transaction_type":{"type":"boolean","example":"true"},"can_see_other_account_iban":{"type":"boolean","example":"true"},"can_add_physical_location":{"type":"boolean","example":"true"},"can_add_corporate_location":{"type":"boolean","example":"true"},"can_delete_image":{"type":"boolean","example":"true"},"can_see_url":{"type":"boolean","example":"true"},"can_see_bank_account_balance":{"type":"boolean","example":"true"},"can_see_transaction_balance":{"type":"boolean","example":"true"},"can_see_transaction_amount":{"type":"boolean","example":"true"},"can_see_other_account_metadata":{"type":"boolean","example":"true"},"can_see_bank_account_type":{"type":"boolean","example":"true"},"can_see_transaction_description":{"type":"boolean","example":"true"}}},"ConsumersJson":{"required":["list"],"properties":{"list":{"type":"array","items":{"$ref":"#/definitions/ConsumerJsonV210"}}}},"TransactionRequestWithChargeJSON210":{"required":["challenge","start_date","id","end_date","status","from","details","charge","type","transaction_ids"],"properties":{"challenge":{"$ref":"#/definitions/ChallengeJsonV140"},"start_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"id":{"type":"string","example":"4050046c-63b3-4868-8a22-14b4181d33a6"},"end_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"status":{"type":"string","example":"COMPLETED"},"from":{"$ref":"#/definitions/TransactionRequestAccountJsonV140"},"details":{"$ref":"#/definitions/TransactionRequestBodyAllTypes"},"charge":{"$ref":"#/definitions/TransactionRequestChargeJsonV200"},"type":{"type":"string","example":"SANDBOX_TAN"},"transaction_ids":{"type":"array","items":{"type":"string"}}}},"TransactionTypesJsonV200":{"required":["transaction_types"],"properties":{"transaction_types":{"type":"array","items":{"$ref":"#/definitions/TransactionTypeJsonV200"}}}},"TransactionRequestWithChargeJSONs210":{"required":["transaction_requests_with_charges"],"properties":{"transaction_requests_with_charges":{"type":"array","items":{"$ref":"#/definitions/TransactionRequestWithChargeJSON210"}}}},"KycChecksJSON":{"required":["checks"],"properties":{"checks":{"type":"array","items":{"$ref":"#/definitions/KycCheckJSON"}}}},"BranchesJson":{"required":["branches"],"properties":{"branches":{"type":"array","items":{"$ref":"#/definitions/BranchJson"}}}},"ModeratedCoreAccountJSON":{"required":["number","account_routing","IBAN","label","owners","swift_bic","balance","bank_id","id","type"],"properties":{"number":{"type":"string","example":"123"},"account_routing":{"$ref":"#/definitions/AccountRoutingJsonV121"},"IBAN":{"type":"string","example":"GR1301720530005053000582373"},"label":{"type":"string","example":"NoneLabel"},"owners":{"type":"array","items":{"$ref":"#/definitions/UserJSONV121"}},"swift_bic":{"type":"string","example":"UKTF3049auf"},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"},"type":{"type":"string","example":"OBP"}}},"KycMediasJSON":{"required":["medias"],"properties":{"medias":{"type":"array","items":{"$ref":"#/definitions/KycMediaJSON"}}}},"KycMediaJSON":{"required":["customer_id","url","customer_number","bank_id","id","date","relates_to_kyc_document_id","relates_to_kyc_check_id","type"],"properties":{"customer_id":{"type":"string","example":"PlaceholderString"},"url":{"type":"string","example":"PlaceholderString"},"customer_number":{"type":"string","example":"5987953"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"PlaceholderString"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"relates_to_kyc_document_id":{"type":"string","example":"PlaceholderString"},"relates_to_kyc_check_id":{"type":"string","example":"PlaceholderString"},"type":{"type":"string","example":"PlaceholderString"}}},"OtherAccountMetadataJSON":{"required":["public_alias","image_URL","physical_location","private_alias","URL","more_info","corporate_location","open_corporates_URL"],"properties":{"public_alias":{"type":"string","example":"NONE"},"image_URL":{"type":"string","example":"www.openbankproject.com"},"physical_location":{"$ref":"#/definitions/LocationJSONV121"},"private_alias":{"type":"string","example":"NONE"},"URL":{"type":"string","example":"www.openbankproject.com"},"more_info":{"type":"string","example":"www.openbankproject.com"},"corporate_location":{"$ref":"#/definitions/LocationJSONV121"},"open_corporates_URL":{"type":"string","example":"www.openbankproject.com"}}},"CustomerJsonV210":{"required":["customer_id","email","mobile_phone_number","customer_number","highest_education_attained","dob_of_dependants","bank_id","date_of_birth","last_ok_date","employment_status","legal_name","face_image","dependants","relationship_status","kyc_status"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"email":{"type":"string","example":"felixsmith@example.com"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"5987953"},"highest_education_attained":{"type":"string","example":"Master"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"bank_id":{"type":"string","example":"gh.29.uk"},"date_of_birth":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"2025-04-15T13:57:28Z"},"employment_status":{"type":"string","example":"worker"},"legal_name":{"type":"string","example":"Eveline Tripman"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"},"kyc_status":{"type":"boolean","example":"false"}}},"EntitlementJSON":{"required":["entitlement_id","role_name","bank_id"],"properties":{"entitlement_id":{"type":"string","example":"6fb17583-1e49-4435-bb74-a14fe0996723"},"role_name":{"type":"string","example":"CanQueryOtherUser"},"bank_id":{"type":"string","example":"gh.29.uk"}}},"UserCustomerLinkJson":{"required":["is_active","customer_id","user_id","date_inserted","user_customer_link_id"],"properties":{"is_active":{"type":"boolean","example":"true"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"date_inserted":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user_customer_link_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}},"ProductsJsonV210":{"required":["products"],"properties":{"products":{"type":"array","items":{"$ref":"#/definitions/ProductJsonV210"}}}},"CustomerJSONs":{"required":["customers"],"properties":{"customers":{"type":"array","items":{"$ref":"#/definitions/CustomerJsonV210"}}}},"AtmsJson":{"required":["atms"],"properties":{"atms":{"type":"array","items":{"$ref":"#/definitions/AtmJson"}}}},"ConnectorMetricsJson":{"required":["metrics"],"properties":{"metrics":{"type":"array","items":{"$ref":"#/definitions/ConnectorMetricJson"}}}},"KycDocumentsJSON":{"required":["documents"],"properties":{"documents":{"type":"array","items":{"$ref":"#/definitions/KycDocumentJSON"}}}},"ViewsJSONV220":{"required":["views"],"properties":{"views":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV220"}}}},"SocialMediasJSON":{"required":["checks"],"properties":{"checks":{"type":"array","items":{"$ref":"#/definitions/SocialMediaJSON"}}}},"PermissionsJSON":{"required":["permissions"],"properties":{"permissions":{"type":"array","items":{"$ref":"#/definitions/PermissionJSON"}}}},"TransactionRequestWithChargeJson":{"required":["challenge","start_date","id","end_date","status","from","details","charge","type","transaction_ids"],"properties":{"challenge":{"$ref":"#/definitions/ChallengeJsonV140"},"start_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"id":{"type":"string","example":"82f92531-9c63-4246-abfc-96c20ec46188"},"end_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"status":{"type":"string","example":"COMPLETED"},"from":{"$ref":"#/definitions/TransactionRequestAccountJsonV140"},"details":{"$ref":"#/definitions/TransactionRequestBody"},"charge":{"$ref":"#/definitions/TransactionRequestChargeJsonV200"},"type":{"type":"string","example":"SANDBOX_TAN"},"transaction_ids":{"type":"string","example":"666666-9c63-4246-abfc-96c20ec46188"}}},"TransactionType":{"required":["shortCode","description","id","charge","bankId","summary"],"properties":{"shortCode":{"type":"string","example":"80080"},"description":{"type":"string","example":"This is the sandbox mode, charging litter money."},"id":{"$ref":"#/definitions/TransactionTypeId"},"charge":{"$ref":"#/definitions/AmountOfMoney"},"bankId":{"$ref":"#/definitions/BankId"},"summary":{"type":"string","example":"SANDBOX_TAN"}}},"TransactionsJSON":{"required":["transactions"],"properties":{"transactions":{"type":"array","items":{"$ref":"#/definitions/TransactionJSON"}}}},"MessageDocsJson":{"required":["message_docs"],"properties":{"message_docs":{"type":"array","items":{"$ref":"#/definitions/MessageDocJson"}}}},"ModeratedAccountJSON":{"required":["number","account_routing","views_available","IBAN","label","owners","swift_bic","balance","bank_id","id","type"],"properties":{"number":{"type":"string","example":"123"},"account_routing":{"$ref":"#/definitions/AccountRoutingJsonV121"},"views_available":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}},"IBAN":{"type":"string","example":"DE89 3704 0044 0532 0130 00"},"label":{"type":"string","example":"NoneLabel"},"owners":{"type":"array","items":{"$ref":"#/definitions/UserJSONV121"}},"swift_bic":{"type":"string","example":"OKOYFIHH"},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"type":{"type":"string","example":"OBP"}}},"TransactionCommentJSON":{"required":["id","value","date","user"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"value":{"type":"string","example":"OBP"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"TransactionRequestTypesJsonV140":{"required":["transaction_request_types"],"properties":{"transaction_request_types":{"type":"array","items":{"$ref":"#/definitions/TransactionRequestTypeJsonV140"}}}},"AvailableRolesJSON":{"required":["roles"],"properties":{"roles":{"type":"array","items":{"$ref":"#/definitions/AvailableRoleJSON"}}}},"FXRateJsonV220":{"required":["inverse_conversion_value","to_currency_code","effective_date","conversion_value","bank_id","from_currency_code"],"properties":{"inverse_conversion_value":{"type":"number","format":"double","example":"0.998"},"to_currency_code":{"type":"string","example":"GBP"},"effective_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"conversion_value":{"type":"number","format":"double","example":"1.001"},"bank_id":{"type":"string","example":"gh.29.uk"},"from_currency_code":{"type":"string","example":"EUR"}}},"UserJsonV200":{"required":["provider","email","username","provider_id","user_id","entitlements"],"properties":{"provider":{"type":"string","example":"http://127.0.0.1:8080"},"email":{"type":"string","example":"felixsmith@example.com"},"username":{"type":"string","example":"felixsmith"},"provider_id":{"type":"string","example":"Chris"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"entitlements":{"$ref":"#/definitions/EntitlementJSONs"}}},"TransactionImageJSON":{"required":["URL","label","id","date","user"],"properties":{"URL":{"type":"string","example":"www.openbankproject.com"},"label":{"type":"string","example":"NONE"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"PhysicalCardJSON":{"required":["allows","expires_date","networks","issue_number","replacement","enabled","collected","technology","cancelled","bank_id","pin_reset","serial_number","account","valid_from_date","bank_card_number","name_on_card","posted","on_hot_list"],"properties":{"allows":{"type":"array","items":{"type":"string"}},"expires_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"networks":{"type":"array","items":{"type":"string"}},"issue_number":{"type":"string","example":"1"},"replacement":{"$ref":"#/definitions/ReplacementJSON"},"enabled":{"type":"boolean","example":"true"},"collected":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"technology":{"type":"string","example":"String"},"cancelled":{"type":"boolean","example":"true"},"bank_id":{"type":"string","example":"gh.29.uk"},"pin_reset":{"type":"array","items":{"$ref":"#/definitions/PinResetJSON"}},"serial_number":{"type":"string","example":"1324234"},"account":{"$ref":"#/definitions/AccountJSON"},"valid_from_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"bank_card_number":{"type":"string","example":"364435172576215"},"name_on_card":{"type":"string","example":"String"},"posted":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"on_hot_list":{"type":"boolean","example":"true"}}},"TransactionJSON":{"required":["this_account","id","details","metadata","other_account"],"properties":{"this_account":{"$ref":"#/definitions/ThisAccountJSON"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"details":{"$ref":"#/definitions/TransactionDetailsJSON"},"metadata":{"$ref":"#/definitions/TransactionMetadataJSON"},"other_account":{"$ref":"#/definitions/OtherAccountJSON"}}},"ConsumerJsonV210":{"required":["created_by_user_id","app_type","description","created_by_user","enabled","redirect_url","developer_email","consumer_id","app_name","created"],"properties":{"created_by_user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"app_type":{"type":"string","example":"Web"},"description":{"type":"string","example":"Account Management"},"created_by_user":{"$ref":"#/definitions/ResourceUserJSON"},"enabled":{"type":"boolean","example":"true"},"redirect_url":{"type":"string","example":"www.openbankproject.com"},"developer_email":{"type":"string","example":"felixsmith@example.com"},"consumer_id":{"type":"integer","format":"int64","example":"1213"},"app_name":{"type":"string","example":"SOFI"},"created":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"TransactionImagesJSON":{"required":["images"],"properties":{"images":{"type":"array","items":{"$ref":"#/definitions/TransactionImageJSON"}}}},"ViewJSONV121":{"required":["can_see_transaction_start_date","can_add_url","can_add_where_tag","can_see_transaction_this_bank_account","can_see_bank_account_owners","can_see_private_alias","can_edit_owner_comment","can_see_other_account_national_identifier","can_see_public_alias","can_see_physical_location","can_see_owner_comment","can_see_bank_account_iban","can_see_corporate_location","can_see_bank_account_number","can_see_other_account_bank_name","description","can_see_transaction_other_bank_account","can_delete_corporate_location","can_see_comments","can_see_bank_account_bank_name","can_add_more_info","can_see_other_account_number","can_see_other_account_swift_bic","can_add_open_corporates_url","can_see_other_account_kind","can_delete_physical_location","can_see_bank_account_label","can_see_transaction_currency","is_public","can_see_transaction_finish_date","can_add_tag","can_see_images","can_see_bank_account_currency","hide_metadata_if_alias_used","can_delete_where_tag","alias","can_add_image_url","can_add_comment","can_see_image_url","id","can_see_bank_account_national_identifier","can_see_tags","can_see_open_corporates_url","short_name","can_delete_tag","can_see_more_info","can_see_transaction_metadata","can_delete_comment","can_see_where_tag","can_add_private_alias","can_add_public_alias","can_see_bank_account_swift_bic","can_add_image","can_see_transaction_type","can_see_other_account_iban","can_add_physical_location","can_add_corporate_location","can_delete_image","can_see_url","can_see_bank_account_balance","can_see_transaction_balance","can_see_transaction_amount","can_see_other_account_metadata","can_see_bank_account_type","can_see_transaction_description"],"properties":{"can_see_transaction_start_date":{"type":"boolean","example":"true"},"can_add_url":{"type":"boolean","example":"true"},"can_add_where_tag":{"type":"boolean","example":"true"},"can_see_transaction_this_bank_account":{"type":"boolean","example":"true"},"can_see_bank_account_owners":{"type":"boolean","example":"true"},"can_see_private_alias":{"type":"boolean","example":"true"},"can_edit_owner_comment":{"type":"boolean","example":"true"},"can_see_other_account_national_identifier":{"type":"boolean","example":"true"},"can_see_public_alias":{"type":"boolean","example":"true"},"can_see_physical_location":{"type":"boolean","example":"true"},"can_see_owner_comment":{"type":"boolean","example":"true"},"can_see_bank_account_iban":{"type":"boolean","example":"true"},"can_see_corporate_location":{"type":"boolean","example":"true"},"can_see_bank_account_number":{"type":"boolean","example":"true"},"can_see_other_account_bank_name":{"type":"boolean","example":"true"},"description":{"type":"string","example":"description"},"can_see_transaction_other_bank_account":{"type":"boolean","example":"true"},"can_delete_corporate_location":{"type":"boolean","example":"true"},"can_see_comments":{"type":"boolean","example":"true"},"can_see_bank_account_bank_name":{"type":"boolean","example":"true"},"can_add_more_info":{"type":"boolean","example":"true"},"can_see_other_account_number":{"type":"boolean","example":"true"},"can_see_other_account_swift_bic":{"type":"boolean","example":"true"},"can_add_open_corporates_url":{"type":"boolean","example":"true"},"can_see_other_account_kind":{"type":"boolean","example":"true"},"can_delete_physical_location":{"type":"boolean","example":"true"},"can_see_bank_account_label":{"type":"boolean","example":"true"},"can_see_transaction_currency":{"type":"boolean","example":"true"},"is_public":{"type":"boolean","example":"true"},"can_see_transaction_finish_date":{"type":"boolean","example":"true"},"can_add_tag":{"type":"boolean","example":"true"},"can_see_images":{"type":"boolean","example":"true"},"can_see_bank_account_currency":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"true"},"can_delete_where_tag":{"type":"boolean","example":"true"},"alias":{"type":"string","example":"None"},"can_add_image_url":{"type":"boolean","example":"true"},"can_add_comment":{"type":"boolean","example":"true"},"can_see_image_url":{"type":"boolean","example":"true"},"id":{"type":"string","example":"123"},"can_see_bank_account_national_identifier":{"type":"boolean","example":"true"},"can_see_tags":{"type":"boolean","example":"true"},"can_see_open_corporates_url":{"type":"boolean","example":"true"},"short_name":{"type":"string","example":"short_name"},"can_delete_tag":{"type":"boolean","example":"true"},"can_see_more_info":{"type":"boolean","example":"true"},"can_see_transaction_metadata":{"type":"boolean","example":"true"},"can_delete_comment":{"type":"boolean","example":"true"},"can_see_where_tag":{"type":"boolean","example":"true"},"can_add_private_alias":{"type":"boolean","example":"true"},"can_add_public_alias":{"type":"boolean","example":"true"},"can_see_bank_account_swift_bic":{"type":"boolean","example":"true"},"can_add_image":{"type":"boolean","example":"true"},"can_see_transaction_type":{"type":"boolean","example":"true"},"can_see_other_account_iban":{"type":"boolean","example":"true"},"can_add_physical_location":{"type":"boolean","example":"true"},"can_add_corporate_location":{"type":"boolean","example":"true"},"can_delete_image":{"type":"boolean","example":"true"},"can_see_url":{"type":"boolean","example":"true"},"can_see_bank_account_balance":{"type":"boolean","example":"true"},"can_see_transaction_balance":{"type":"boolean","example":"true"},"can_see_transaction_amount":{"type":"boolean","example":"true"},"can_see_other_account_metadata":{"type":"boolean","example":"true"},"can_see_bank_account_type":{"type":"boolean","example":"true"},"can_see_transaction_description":{"type":"boolean","example":"true"}}},"PostCounterpartyBespokeJson":{"required":["key","value"],"properties":{"key":{"type":"string","example":"englishName"},"value":{"type":"string","example":"english Name"}}},"LocationPlainJSON":{"required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","example":"1.532"},"longitude":{"type":"number","format":"double","example":"1.535"}}},"AddressJsonV140":{"required":["city","line_2","state","postcode","country","line_3","line_1"],"properties":{"city":{"type":"string","example":"Berlin"},"line_2":{"type":"string","example":"Wedding"},"state":{"type":"string","example":"Berlin Brandenburg"},"postcode":{"type":"string","example":"13359"},"country":{"type":"string","example":"DE"},"line_3":{"type":"string","example":""},"line_1":{"type":"string","example":"Osloer Straße 16/17"}}},"LocationJsonV140":{"required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","example":"11.45"},"longitude":{"type":"number","format":"double","example":"11.45"}}},"LicenseJsonV140":{"required":["id","name"],"properties":{"id":{"type":"string","example":"ODbL-1.0"},"name":{"type":"string","example":"Open Database License"}}},"MetaJsonV140":{"required":["license"],"properties":{"license":{"$ref":"#/definitions/LicenseJsonV140"}}},"LobbyStringJson":{"required":["hours"],"properties":{"hours":{"type":"string","example":"5"}}},"DriveUpStringJson":{"required":["hours"],"properties":{"hours":{"type":"string","example":"5"}}},"BranchRoutingJsonV141":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"DERBY6"}}},"AmountOfMoneyJsonV121":{"required":["currency","amount"],"properties":{"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"0"}}},"IbanJson":{"required":["iban"],"properties":{"iban":{"type":"string","example":"123"}}},"CustomerFaceImageJson":{"required":["url","date"],"properties":{"url":{"type":"string","example":"www.openbankproject"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"CustomerCreditRatingJSON":{"required":["rating","source"],"properties":{"rating":{"type":"string","example":"OBP"},"source":{"type":"string","example":"OBP"}}},"AccountRoutingJsonV121":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"UK123456"}}},"TransactionTypeId":{"required":["value"],"properties":{"value":{"type":"string","example":"123"}}},"TransactionRequestAccountJsonV140":{"required":["bank_id","account_id"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}}},"BankRoutingJsonV121":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"BIC"},"address":{"type":"string","example":"OKOYFIHH"}}},"ReplacementJSON":{"required":["requested_date","reason_requested"],"properties":{"requested_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"reason_requested":{"type":"string","example":"RENEW"}}},"PinResetJSON":{"required":["requested_date","reason_requested"],"properties":{"requested_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"reason_requested":{"type":"string","example":"FORGOT"}}},"SandboxBankImport":{"required":["website","full_name","logo","id","short_name"],"properties":{"website":{"type":"string","example":"http://example.com"},"full_name":{"type":"string","example":"Bank 1 Inc."},"logo":{"type":"string","example":"http://example.com/logo"},"id":{"type":"string","example":"bank1"},"short_name":{"type":"string","example":"bank 1"}}},"SandboxUserImport":{"required":["email","password","user_name"],"properties":{"email":{"type":"string","example":"user1@example.com"},"password":{"type":"string","example":"TESOBE520berlin123!"},"user_name":{"type":"string","example":"User 1"}}},"SandboxBalanceImport":{"required":["currency","amount"],"properties":{"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"1000.00"}}},"SandboxAccountImport":{"required":["generate_auditors_view","number","IBAN","label","owners","balance","bank","id","type","generate_accountants_view","generate_public_view"],"properties":{"generate_auditors_view":{"type":"boolean","example":"true"},"number":{"type":"string","example":"1"},"IBAN":{"type":"string","example":"1234567890"},"label":{"type":"string","example":"Account 1 at Bank 1"},"owners":{"type":"array","items":{"type":"string"}},"balance":{"$ref":"#/definitions/SandboxBalanceImport"},"bank":{"type":"string","example":"bank1"},"id":{"type":"string","example":"account1"},"type":{"type":"string","example":"savings"},"generate_accountants_view":{"type":"boolean","example":"true"},"generate_public_view":{"type":"boolean","example":"true"}}},"SandboxAccountIdImport":{"required":["id","bank"],"properties":{"id":{"type":"string","example":"account1"},"bank":{"type":"string","example":"bank2"}}},"SandboxAccountDetailsImport":{"required":["new_balance","description","completed","type","value","posted"],"properties":{"new_balance":{"type":"string","example":"1244.00"},"description":{"type":"string","example":"some description"},"completed":{"type":"string","example":"2012-04-07T00:00:00.001Z"},"type":{"type":"string","example":"SEPA"},"value":{"type":"string","example":"-135.33"},"posted":{"type":"string","example":"2012-03-07T00:00:00.001Z"}}},"SandboxTransactionImport":{"required":["id","this_account","details"],"properties":{"id":{"type":"string","example":"transaction-without-counterparty"},"this_account":{"$ref":"#/definitions/SandboxAccountIdImport"},"counterparty":{"$ref":"#/definitions/SandboxTransactionCounterparty"},"details":{"$ref":"#/definitions/SandboxAccountDetailsImport"}}},"SandboxTransactionCounterparty":{"properties":{"name":{"type":"string"},"account_number":{"type":"string","example":"123456-AVB"}}},"SandboxAddressImport":{"required":["city","line_2","state","post_code","county","country_code","line_3","line_1"],"properties":{"city":{"type":"string","example":"Ashbourne"},"line_2":{"type":"string","example":"Rosy Place"},"state":{"type":"string","example":""},"post_code":{"type":"string","example":"WHY RU4"},"county":{"type":"string","example":"Derbyshire"},"country_code":{"type":"string","example":"UK"},"line_3":{"type":"string","example":"Sunny Village"},"line_1":{"type":"string","example":"5 Some Street"}}},"SandboxLocationImport":{"required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","example":"52.556198"},"longitude":{"type":"number","format":"double","example":"13.384099"}}},"SandboxLicenseImport":{"required":["id","name"],"properties":{"id":{"type":"string","example":"pddl"},"name":{"type":"string","example":"Open Data Commons Public Domain Dedication and License (PDDL)"}}},"SandboxMetaImport":{"required":["license"],"properties":{"license":{"$ref":"#/definitions/SandboxLicenseImport"}}},"SandboxLobbyImport":{"required":["hours"],"properties":{"hours":{"type":"string","example":"M-TH 8:30-3:30, F 9-5"}}},"SandboxDriveUpImport":{"required":["hours"],"properties":{"hours":{"type":"string","example":"M-Th 8:30-5:30, F-8:30-6, Sat 9-12"}}},"SandboxBranchImport":{"required":["name","location","bank_id","id","meta","address"],"properties":{"name":{"type":"string","example":"Genel Müdürlük"},"location":{"$ref":"#/definitions/SandboxLocationImport"},"driveUp":{"$ref":"#/definitions/SandboxDriveUpImport"},"bank_id":{"type":"string","example":"bank1"},"id":{"type":"string","example":"branch1"},"meta":{"$ref":"#/definitions/SandboxMetaImport"},"lobby":{"$ref":"#/definitions/SandboxLobbyImport"},"address":{"$ref":"#/definitions/SandboxAddressImport"}}},"SandboxAtmImport":{"required":["name","location","bank_id","id","meta","address"],"properties":{"name":{"type":"string","example":"Ashbourne Atm 1"},"location":{"$ref":"#/definitions/SandboxLocationImport"},"bank_id":{"type":"string","example":"bank1"},"id":{"type":"string","example":"atm1"},"meta":{"$ref":"#/definitions/SandboxMetaImport"},"address":{"$ref":"#/definitions/SandboxAddressImport"}}},"SandboxProductImport":{"required":["name","more_info_url","super_family","code","bank_id","meta","category","family"],"properties":{"name":{"type":"string","example":"product 1"},"more_info_url":{"type":"string","example":"www.example.com/index1"},"super_family":{"type":"string","example":"sup fam 1"},"code":{"type":"string","example":"prd1"},"bank_id":{"type":"string","example":"bank1"},"meta":{"$ref":"#/definitions/SandboxMetaImport"},"category":{"type":"string","example":"cat1"},"family":{"type":"string","example":"fam1"}}},"SandboxCustomerImport":{"required":["name","number"],"properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"string","example":"698761728934"}}},"SandboxCrmEventImport":{"required":["channel","bank_id","id","customer","category","detail","actual_date"],"properties":{"channel":{"type":"string","example":"Phone"},"bank_id":{"type":"string","example":"bank1"},"id":{"type":"string","example":"ASDFHJ47YKJH"},"customer":{"$ref":"#/definitions/SandboxCustomerImport"},"category":{"type":"string","example":"Call"},"detail":{"type":"string","example":"Check mortgage"},"actual_date":{"type":"string","example":"1100-01-01T01:01:01.000Z"}}},"CounterpartyIdJson":{"required":["counterparty_id"],"properties":{"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"TransactionRequestAttributeJsonV400":{"required":["name","attribute_type","value"],"properties":{"name":{"type":"string","example":"HOUSE_RENT"},"attribute_type":{"type":"string","example":"STRING"},"value":{"type":"string","example":"123456789"}}},"UserJSONV210":{"required":["id","provider","username"],"properties":{"id":{"type":"string","example":"123"},"provider":{"type":"string","example":"http://127.0.0.1:8080"},"username":{"type":"string","example":"felixsmith"}}},"LocationJsonV210":{"required":["latitude","longitude","date","user"],"properties":{"latitude":{"type":"number","format":"double","example":"11.45"},"longitude":{"type":"number","format":"double","example":"11.45"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV210"}}},"CounterpartyMetadataJson":{"required":["public_alias","physical_location","image_url","private_alias","url","more_info","corporate_location","open_corporates_url"],"properties":{"public_alias":{"type":"string","example":"String"},"physical_location":{"$ref":"#/definitions/LocationJsonV210"},"image_url":{"type":"string","example":"String"},"private_alias":{"type":"string","example":"String"},"url":{"type":"string","example":"String"},"more_info":{"type":"string","example":"String"},"corporate_location":{"$ref":"#/definitions/LocationJsonV210"},"open_corporates_url":{"type":"string","example":"String"}}},"BasicViewJson":{"required":["id","short_name","is_public"],"properties":{"id":{"type":"string","example":"1"},"short_name":{"type":"string","example":"HHH"},"is_public":{"type":"boolean","example":"true"}}},"BasicAccountJSON":{"required":["id","label","bank_id","views_available"],"properties":{"id":{"type":"string","example":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"},"label":{"type":"string","example":"NoneLabel"},"bank_id":{"type":"string","example":"gh.29.uk"},"views_available":{"type":"array","items":{"$ref":"#/definitions/BasicViewJson"}}}},"CoreAccountJSON":{"required":["id","label","bank_id","_links"],"properties":{"id":{"type":"string","example":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"},"label":{"type":"string","example":"NoneLabel"},"bank_id":{"type":"string","example":"gh.29.uk"},"_links":{"type":"object","properties":{"jsonString":{"type":"string","example":"{}"}},"required":["jsonString"]}}},"AccountHolderJSON":{"required":["name","is_alias"],"properties":{"name":{"type":"string","example":"OBP"},"is_alias":{"type":"boolean","example":"true"}}},"MinimalBankJSON":{"required":["national_identifier","name"],"properties":{"national_identifier":{"type":"string","example":"OBP"},"name":{"type":"string","example":"OBP"}}},"HostedBy":{"required":["organisation","email","phone","organisation_website"],"properties":{"organisation":{"type":"string","example":"String"},"email":{"type":"string","example":"String"},"phone":{"type":"string","example":"String"},"organisation_website":{"type":"string","example":"String"}}},"CounterpartyJsonV220":{"required":["other_account_routing_address","other_account_routing_scheme","created_by_user_id","name","other_account_secondary_routing_address","is_beneficiary","description","other_branch_routing_address","bespoke","other_bank_routing_scheme","other_branch_routing_scheme","this_account_id","this_view_id","other_bank_routing_address","this_bank_id","counterparty_id","other_account_secondary_routing_scheme"],"properties":{"other_account_routing_address":{"type":"string","example":"DE89370400440532013000"},"other_account_routing_scheme":{"type":"string","example":"IBAN"},"created_by_user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"name":{"type":"string","example":"CounterpartyName"},"other_account_secondary_routing_address":{"type":"string","example":"DE89370400440532013000"},"is_beneficiary":{"type":"boolean","example":"true"},"description":{"type":"string","example":"My landlord"},"other_branch_routing_address":{"type":"string","example":"12f8a9e6-c2b1-407a-8bd0-421b7119307e"},"bespoke":{"type":"array","items":{"$ref":"#/definitions/PostCounterpartyBespokeJson"}},"other_bank_routing_scheme":{"type":"string","example":"OBP"},"other_branch_routing_scheme":{"type":"string","example":"OBP"},"this_account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"this_view_id":{"type":"string","example":"owner"},"other_bank_routing_address":{"type":"string","example":"gh.29.uk"},"this_bank_id":{"type":"string","example":"gh.29.uk"},"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"other_account_secondary_routing_scheme":{"type":"string","example":"IBAN"}}},"CustomerMessageJson":{"required":["from_person","id","date","from_department","message"],"properties":{"from_person":{"type":"string","example":"String"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"from_department":{"type":"string","example":"String"},"message":{"type":"string","example":"String"}}},"AccountJSON":{"required":["id","label","views_available","bank_id"],"properties":{"id":{"type":"string","example":"123"},"label":{"type":"string","example":"OBP"},"views_available":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}},"bank_id":{"type":"string","example":"gh.29.uk"}}},"UserJSONV121":{"required":["id","provider","display_name"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"provider":{"type":"string","example":"http://127.0.0.1:8080"},"display_name":{"type":"string","example":"OBP"}}},"LocationJSONV121":{"required":["latitude","longitude","date","user"],"properties":{"latitude":{"type":"number","format":"double","example":"1.231"},"longitude":{"type":"number","format":"double","example":"1.231"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"TransactionRequestTypeJSONV210":{"required":["transaction_request_type"],"properties":{"transaction_request_type":{"type":"string","example":"SandboxTan"}}},"CrmEventJson":{"required":["channel","customer_name","result","customer_number","bank_id","id","scheduled_date","category","detail","actual_date"],"properties":{"channel":{"type":"string","example":"String"},"customer_name":{"type":"string","example":"String"},"result":{"type":"string","example":"String"},"customer_number":{"type":"string","example":"5987953"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"scheduled_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"category":{"type":"string","example":"String"},"detail":{"type":"string","example":"String"},"actual_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"MetricJson":{"required":["duration","implemented_in_version","url","correlation_id","implemented_by_partial_function","user_id","developer_email","date","consumer_id","verb","app_name","user_name"],"properties":{"duration":{"type":"integer","format":"int64","example":"39"},"implemented_in_version":{"type":"string","example":"v210"},"url":{"type":"string","example":"www.openbankproject.com"},"correlation_id":{"type":"string","example":"v8ho6h5ivel3uq7a5zcnv0w1"},"implemented_by_partial_function":{"type":"string","example":"getBanks"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"developer_email":{"type":"string","example":"felixsmith@example.com"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"consumer_id":{"type":"string","example":"123"},"verb":{"type":"string","example":"get"},"app_name":{"type":"string","example":"SOFI"},"user_name":{"type":"string","example":"OBP"}}},"PortJSON":{"required":["property","value"],"properties":{"property":{"type":"string","example":"default"},"value":{"type":"string","example":"8080"}}},"AkkaJSON":{"required":["ports","log_level"],"properties":{"ports":{"type":"array","items":{"$ref":"#/definitions/PortJSON"}},"log_level":{"type":"string","example":"Debug"},"remote_data_secret_matched":{"type":"boolean","example":"true"}}},"MetricsJsonV220":{"required":["property","value"],"properties":{"property":{"type":"string","example":"String"},"value":{"type":"string","example":"Mapper"}}},"WarehouseJSON":{"required":["property","value"],"properties":{"property":{"type":"string","example":"String"},"value":{"type":"string","example":"ElasticSearch"}}},"ElasticSearchJSON":{"required":["metrics","warehouse"],"properties":{"metrics":{"type":"array","items":{"$ref":"#/definitions/MetricsJsonV220"}},"warehouse":{"type":"array","items":{"$ref":"#/definitions/WarehouseJSON"}}}},"CachedFunctionJSON":{"required":["function_name","ttl_in_seconds"],"properties":{"function_name":{"type":"string","example":"getBanks"},"ttl_in_seconds":{"type":"integer","format":"int32","example":"5"}}},"ScopesJSON":{"required":["require_scopes_for_all_roles","require_scopes_for_listed_roles"],"properties":{"require_scopes_for_all_roles":{"type":"boolean","example":"true"},"require_scopes_for_listed_roles":{"type":"array","items":{"type":"string"}}}},"ResourceUserJSON":{"required":["provider","email","username","provider_id","user_id"],"properties":{"provider":{"type":"string","example":"http://127.0.0.1:8080"},"email":{"type":"string","example":"felixsmith@example.com"},"username":{"type":"string","example":"felixsmith"},"provider_id":{"type":"string","example":"Chris"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}},"TransactionRequestAccount":{"required":["bank_id","account_id"],"properties":{"bank_id":{"type":"string","example":"String"},"account_id":{"type":"string","example":"String"}}},"TransactionRequestIban":{"required":["iban"],"properties":{"iban":{"type":"string","example":"String"}}},"TransactionRequestCounterpartyId":{"required":["counterparty_id"],"properties":{"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"TransactionRequestSimple":{"required":["otherAccountSecondaryRoutingAddress","otherBankRoutingScheme","otherBranchRoutingScheme","otherAccountRoutingScheme","otherBankRoutingAddress","otherAccountRoutingAddress","otherAccountSecondaryRoutingScheme","otherBranchRoutingAddress"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"string","example":"DE91 1000 0000 0123 4567 89"},"otherBankRoutingScheme":{"type":"string","example":"BIC"},"otherBranchRoutingScheme":{"type":"string","example":"BRANCH-CODE"},"otherAccountRoutingScheme":{"type":"string","example":"IBAN"},"otherBankRoutingAddress":{"type":"string","example":"GENODEM1GLS"},"otherAccountRoutingAddress":{"type":"string","example":"DE91 1000 0000 0123 4567 89"},"otherAccountSecondaryRoutingScheme":{"type":"string","example":"IBAN"},"otherBranchRoutingAddress":{"type":"string","example":"DERBY6"}}},"FromAccountTransfer":{"required":["mobile_phone_number","nickname"],"properties":{"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"nickname":{"type":"string","example":"String"}}},"ToAccountTransferToPhone":{"required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"}}},"TransactionRequestTransferToPhone":{"required":["description","to","from","message","value"],"properties":{"description":{"type":"string","example":"String"},"to":{"$ref":"#/definitions/ToAccountTransferToPhone"},"from":{"$ref":"#/definitions/FromAccountTransfer"},"message":{"type":"string","example":"String"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"ToAccountTransferToAtmKycDocument":{"required":["type","number"],"properties":{"type":{"type":"string","example":"String"},"number":{"type":"string","example":"String"}}},"ToAccountTransferToAtm":{"required":["legal_name","date_of_birth","mobile_phone_number","kyc_document"],"properties":{"legal_name":{"type":"string","example":"Eveline Tripman"},"date_of_birth":{"type":"string","example":"20181230"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"kyc_document":{"$ref":"#/definitions/ToAccountTransferToAtmKycDocument"}}},"TransactionRequestTransferToAtm":{"required":["description","to","from","message","value"],"properties":{"description":{"type":"string","example":"String"},"to":{"$ref":"#/definitions/ToAccountTransferToAtm"},"from":{"$ref":"#/definitions/FromAccountTransfer"},"message":{"type":"string","example":"String"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"ToAccountTransferToAccountAccount":{"required":["number","iban"],"properties":{"number":{"type":"string","example":"String"},"iban":{"type":"string","example":"String"}}},"ToAccountTransferToAccount":{"required":["name","bank_code","branch_number","account"],"properties":{"name":{"type":"string","example":"String"},"bank_code":{"type":"string","example":"String"},"branch_number":{"type":"string","example":"String"},"account":{"$ref":"#/definitions/ToAccountTransferToAccountAccount"}}},"TransactionRequestTransferToAccount":{"required":["description","future_date","to","transfer_type","value"],"properties":{"description":{"type":"string","example":"String"},"future_date":{"type":"string","example":"20181230"},"to":{"$ref":"#/definitions/ToAccountTransferToAccount"},"transfer_type":{"type":"string","example":"String"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"PaymentAccount":{"required":["iban"],"properties":{"iban":{"type":"string","example":"12345"}}},"SepaCreditTransfers":{"required":["debtorAccount","instructedAmount","creditorAccount","creditorName"],"properties":{"debtorAccount":{"$ref":"#/definitions/PaymentAccount"},"instructedAmount":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"creditorAccount":{"$ref":"#/definitions/PaymentAccount"},"creditorName":{"type":"string","example":"John Miles"}}},"TransactionRequestAgentCashWithdrawal":{"required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"agent_number":{"type":"string","example":"5987953"}}},"AmountOfMoney":{"required":["currency","amount"],"properties":{"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"100"}}},"TransactionRequestBodyAllTypes":{"required":["description","value"],"properties":{"to_transfer_to_phone":{"$ref":"#/definitions/TransactionRequestTransferToPhone"},"description":{"type":"string","example":"Description of the object. Maximum length is 2000. It can be any characters here."},"to_transfer_to_atm":{"$ref":"#/definitions/TransactionRequestTransferToAtm"},"to_counterparty":{"$ref":"#/definitions/TransactionRequestCounterpartyId"},"to_agent":{"$ref":"#/definitions/TransactionRequestAgentCashWithdrawal"},"to_sepa_credit_transfers":{"$ref":"#/definitions/SepaCreditTransfers"},"to_simple":{"$ref":"#/definitions/TransactionRequestSimple"},"to_sepa":{"$ref":"#/definitions/TransactionRequestIban"},"to_transfer_to_account":{"$ref":"#/definitions/TransactionRequestTransferToAccount"},"value":{"$ref":"#/definitions/AmountOfMoney"},"to_sandbox_tan":{"$ref":"#/definitions/TransactionRequestAccount"}}},"ChallengeJsonV140":{"required":["id","allowed_attempts","challenge_type"],"properties":{"id":{"type":"string","example":"be1a183d-b301-4b83-b855-5eeffdd3526f"},"allowed_attempts":{"type":"integer","format":"int32","example":"3"},"challenge_type":{"type":"string","example":"SANDBOX_TAN"}}},"TransactionRequestChargeJsonV200":{"required":["summary","value"],"properties":{"summary":{"type":"string","example":"Rent the flat"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"ConnectorMetricJson":{"required":["connector_name","duration","function_name","correlation_id","date"],"properties":{"connector_name":{"type":"string","example":"mapper"},"duration":{"type":"integer","format":"int64","example":"1000"},"function_name":{"type":"string","example":"getBanks"},"correlation_id":{"type":"string","example":"12345"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"PermissionJSON":{"required":["user","views"],"properties":{"user":{"$ref":"#/definitions/UserJSONV121"},"views":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}}}},"TransactionRequestBody":{"required":["to","value","description"],"properties":{"to":{"$ref":"#/definitions/TransactionRequestAccount"},"value":{"$ref":"#/definitions/AmountOfMoney"},"description":{"type":"string","example":"String"}}},"BankId":{"required":["value"],"properties":{"value":{"type":"string","example":"gh.uk.9j"}}},"ThisAccountJSON":{"required":["number","IBAN","swift_bic","bank","id","holders","kind"],"properties":{"number":{"type":"string","example":"123"},"IBAN":{"type":"string","example":"UK1234AD"},"swift_bic":{"type":"string","example":"UK1234AD"},"bank":{"$ref":"#/definitions/MinimalBankJSON"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"holders":{"type":"array","items":{"$ref":"#/definitions/AccountHolderJSON"}},"kind":{"type":"string","example":"AC"}}},"TransactionDetailsJSON":{"required":["new_balance","description","completed","type","value","posted"],"properties":{"new_balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"this is for family"},"completed":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"type":{"type":"string","example":"AC"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"posted":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"TransactionMetadataJSON":{"required":["narrative","tags","where","images","comments"],"properties":{"narrative":{"type":"string","example":"NONE"},"tags":{"type":"array","items":{"$ref":"#/definitions/TransactionTagJSON"}},"where":{"$ref":"#/definitions/LocationJSONV121"},"images":{"type":"array","items":{"$ref":"#/definitions/TransactionImageJSON"}},"comments":{"type":"array","items":{"$ref":"#/definitions/TransactionCommentJSON"}}}},"AdapterImplementationJson":{"required":["group","suggested_order"],"properties":{"group":{"type":"string","example":"CORE"},"suggested_order":{"type":"integer","format":"int32","example":"3"}}},"EndpointInfo":{"required":["name","version"],"properties":{"name":{"type":"string","example":"getAccounts"},"version":{"type":"string","example":"OBPv3.0.0"}}},"FieldNameApiVersions":{"properties":{}},"MessageDocJson":{"required":["adapter_implementation","example_inbound_message","description","process","message_format","example_outbound_message","dependent_endpoints"],"properties":{"adapter_implementation":{"$ref":"#/definitions/AdapterImplementationJson"},"outboundAvroSchema":{"type":"object","properties":{"jsonString":{"type":"string","example":"{}"}},"required":["jsonString"]},"example_inbound_message":{"type":"object","properties":{"jsonString":{"type":"string","example":"{}"}},"required":["jsonString"]},"inboundAvroSchema":{"type":"object","properties":{"jsonString":{"type":"string","example":"{}"}},"required":["jsonString"]},"requiredFieldInfo":{"$ref":"#/definitions/FieldNameApiVersions"},"description":{"type":"string","example":"get Banks"},"process":{"type":"string","example":"getAccounts"},"message_format":{"type":"string","example":"rest_vMar2019"},"example_outbound_message":{"type":"object","properties":{"jsonString":{"type":"string","example":"{}"}},"required":["jsonString"]},"dependent_endpoints":{"type":"array","items":{"$ref":"#/definitions/EndpointInfo"}},"outbound_topic":{"type":"string","example":"to.obp.api.1.caseclass.OutboundGetAccounts"},"inbound_topic":{"type":"string","example":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts"}}},"TransactionRequestChargeJsonV140":{"required":["summary","value"],"properties":{"summary":{"type":"string","example":"The bank fixed charge"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"TransactionRequestTypeJsonV140":{"required":["value","charge"],"properties":{"value":{"type":"string","example":"10"},"charge":{"$ref":"#/definitions/TransactionRequestChargeJsonV140"}}},"AvailableRoleJSON":{"required":["role","requires_bank_id"],"properties":{"role":{"type":"string","example":"CanCreateBranch"},"requires_bank_id":{"type":"boolean","example":"true"}}}}}