API Explorer

v1 (610 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Delete Bank Level Dynamic Endpoint

Delete a Bank Level DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteBankLevelDynamicEndpoint - Please login to request this Role
  • CanDeleteDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteBankLevelDynamicEndpoint, operation_id: OBPv4.0.0-deleteBankLevelDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API,

Delete Dynamic Endpoint

Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteDynamicEndpoint, operation_id: OBPv4.0.0-deleteDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API,

Get Bank Level Dynamic Endpoint

Get a Bank Level Dynamic Endpoint.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "title":"Bank Accounts (Dynamic Endpoint)", "version":"1.0.0" }, "definitions":{ "AccountName":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"family account" }, "balance":{ "type":"integer", "format":"int64", "example":1000.123 } } } }, "paths":{ "/accounts":{ "post":{ "operationId":"POST_account", "produces":["application/json"], "responses":{ "201":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"POST Accounts", "summary":"POST Accounts" } }, "/accounts/{account_id}":{ "get":{ "operationId":"GET_account", "produces":["application/json"], "responses":{ "200":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"Get Bank Account", "summary":"Get Bank Account by Id" } } }, "host":"obp_mock", "schemes":["http","https"] } }
Required Roles:
  • CanGetBankLevelDynamicEndpoint - Please login to request this Role
  • CanGetDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getBankLevelDynamicEndpoint, operation_id: OBPv4.0.0-getBankLevelDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API,

Get Dynamic Endpoints

Get Dynamic Endpoints.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_endpoints":[{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "title":"Bank Accounts (Dynamic Endpoint)", "version":"1.0.0" }, "definitions":{ "AccountName":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"family account" }, "balance":{ "type":"integer", "format":"int64", "example":1000.123 } } } }, "paths":{ "/accounts":{ "post":{ "operationId":"POST_account", "produces":["application/json"], "responses":{ "201":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"POST Accounts", "summary":"POST Accounts" } }, "/accounts/{account_id}":{ "get":{ "operationId":"GET_account", "produces":["application/json"], "responses":{ "200":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"Get Bank Account", "summary":"Get Bank Account by Id" } } }, "host":"obp_mock", "schemes":["http","https"] } }] }
Required Roles:
  • CanGetDynamicEndpoints - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getDynamicEndpoints, operation_id: OBPv4.0.0-getDynamicEndpoints Tags: Dynamic-Endpoint-Manage, API,

Update Bank Level Dynamic Endpoint Host

Update Bank Level dynamic endpoint Host.
The value can be obp_mock, dynamic_entity, or some service url.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "host":"dynamic_entity" }
Required Roles:
  • CanUpdateBankLevelDynamicEndpoint - Please login to request this Role
  • CanUpdateDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-09001: DynamicEntity not found. Please specify a valid value for DYNAMIC_ENTITY_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateBankLevelDynamicEndpointHost, operation_id: OBPv4.0.0-updateBankLevelDynamicEndpointHost Tags: Dynamic-Endpoint-Manage, API,

Update Dynamic Endpoint Host

Update dynamic endpoint Host.
The value can be obp_mock, dynamic_entity, or some service url.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "host":"dynamic_entity" }
Required Roles:
  • CanUpdateDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-09001: DynamicEntity not found. Please specify a valid value for DYNAMIC_ENTITY_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateDynamicEndpointHost, operation_id: OBPv4.0.0-updateDynamicEndpointHost Tags: Dynamic-Endpoint-Manage, API,

Create Bank Level Dynamic Endpoint

Create dynamic endpoints.

Create dynamic endpoints with one json format swagger content.

If the host of swagger is dynamic_entity, then you need link the swagger fields to the dynamic entity fields,
please check Endpoint Mapping endpoints.

If the host of swagger is obp_mock, every dynamic endpoint will return example response of swagger,

when create MethodRouting for given dynamic endpoint, it will be routed to given url.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "title":"Bank Accounts (Dynamic Endpoint)", "version":"1.0.0" }, "definitions":{ "AccountName":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"family account" }, "balance":{ "type":"integer", "format":"int64", "example":1000.123 } } } }, "paths":{ "/accounts":{ "post":{ "operationId":"POST_account", "produces":["application/json"], "responses":{ "201":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"POST Accounts", "summary":"POST Accounts" } }, "/accounts/{account_id}":{ "get":{ "operationId":"GET_account", "produces":["application/json"], "responses":{ "200":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"Get Bank Account", "summary":"Get Bank Account by Id" } } }, "host":"obp_mock", "schemes":["http","https"] } }
Required Roles:
  • CanCreateBankLevelDynamicEndpoint - Please login to request this Role
  • CanCreateDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-09008: DynamicEndpoint already exists.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createBankLevelDynamicEndpoint, operation_id: OBPv4.0.0-createBankLevelDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API,

Create Dynamic Endpoint

Create dynamic endpoints.

Create dynamic endpoints with one json format swagger content.

If the host of swagger is dynamic_entity, then you need link the swagger fields to the dynamic entity fields,
please check Endpoint Mapping endpoints.

If the host of swagger is obp_mock, every dynamic endpoint will return example response of swagger,

when create MethodRouting for given dynamic endpoint, it will be routed to given url.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "title":"Bank Accounts (Dynamic Endpoint)", "version":"1.0.0" }, "definitions":{ "AccountName":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"family account" }, "balance":{ "type":"integer", "format":"int64", "example":1000.123 } } } }, "paths":{ "/accounts":{ "post":{ "operationId":"POST_account", "produces":["application/json"], "responses":{ "201":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"POST Accounts", "summary":"POST Accounts" } }, "/accounts/{account_id}":{ "get":{ "operationId":"GET_account", "produces":["application/json"], "responses":{ "200":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"Get Bank Account", "summary":"Get Bank Account by Id" } } }, "host":"obp_mock", "schemes":["http","https"] } }
Required Roles:
  • CanCreateDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-09008: DynamicEndpoint already exists.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createDynamicEndpoint, operation_id: OBPv4.0.0-createDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API,

Delete My Dynamic Endpoint

Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteMyDynamicEndpoint, operation_id: OBPv4.0.0-deleteMyDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API,

Get Bank Level Dynamic Endpoints

Get Bank Level Dynamic Endpoints.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_endpoints":[{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "title":"Bank Accounts (Dynamic Endpoint)", "version":"1.0.0" }, "definitions":{ "AccountName":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"family account" }, "balance":{ "type":"integer", "format":"int64", "example":1000.123 } } } }, "paths":{ "/accounts":{ "post":{ "operationId":"POST_account", "produces":["application/json"], "responses":{ "201":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"POST Accounts", "summary":"POST Accounts" } }, "/accounts/{account_id}":{ "get":{ "operationId":"GET_account", "produces":["application/json"], "responses":{ "200":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"Get Bank Account", "summary":"Get Bank Account by Id" } } }, "host":"obp_mock", "schemes":["http","https"] } }] }
Required Roles:
  • CanGetBankLevelDynamicEndpoints - Please login to request this Role
  • CanGetDynamicEndpoints - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getBankLevelDynamicEndpoints, operation_id: OBPv4.0.0-getBankLevelDynamicEndpoints Tags: Dynamic-Endpoint-Manage, API,

Get Dynamic Endpoint

Get a Dynamic Endpoint.

Get one DynamicEndpoint,

Authentication is Mandatory

Typical Successful Response:

								
									
{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "title":"Bank Accounts (Dynamic Endpoint)", "version":"1.0.0" }, "definitions":{ "AccountName":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"family account" }, "balance":{ "type":"integer", "format":"int64", "example":1000.123 } } } }, "paths":{ "/accounts":{ "post":{ "operationId":"POST_account", "produces":["application/json"], "responses":{ "201":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"POST Accounts", "summary":"POST Accounts" } }, "/accounts/{account_id}":{ "get":{ "operationId":"GET_account", "produces":["application/json"], "responses":{ "200":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"Get Bank Account", "summary":"Get Bank Account by Id" } } }, "host":"obp_mock", "schemes":["http","https"] } }
Required Roles:
  • CanGetDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getDynamicEndpoint, operation_id: OBPv4.0.0-getDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API,

Get My Dynamic Endpoints

Get My Dynamic Endpoints.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_endpoints":[{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "title":"Bank Accounts (Dynamic Endpoint)", "version":"1.0.0" }, "definitions":{ "AccountName":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"family account" }, "balance":{ "type":"integer", "format":"int64", "example":1000.123 } } } }, "paths":{ "/accounts":{ "post":{ "operationId":"POST_account", "produces":["application/json"], "responses":{ "201":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"POST Accounts", "summary":"POST Accounts" } }, "/accounts/{account_id}":{ "get":{ "operationId":"GET_account", "produces":["application/json"], "responses":{ "200":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"Get Bank Account", "summary":"Get Bank Account by Id" } } }, "host":"obp_mock", "schemes":["http","https"] } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getMyDynamicEndpoints, operation_id: OBPv4.0.0-getMyDynamicEndpoints Tags: Dynamic-Endpoint-Manage, API,