API Explorer

v4.0.0 (382 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Endpoint Mapping

Create an Endpoint Mapping.

Note: at moment only support the dynamic endpoints

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "operation_id":"OBPv4.0.0-dynamicEndpoint_GET_pet_PET_ID", "request_mapping":"{}", "response_mapping":"{}" }
Required Roles:
  • CanCreateEndpointMapping - 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 createEndpointMapping, operation_id: OBPv4.0.0-createEndpointMapping Tags: Endpoint-Mapping, New-Style,

Delete Endpoint Mapping

Delete a Endpoint Mapping.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
true
Required Roles:
  • CanDeleteEndpointMapping - 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 deleteEndpointMapping, operation_id: OBPv4.0.0-deleteEndpointMapping Tags: Endpoint-Mapping, New-Style,

Get Endpoint Mapping by Id

Get an Endpoint Mapping by ENDPOINT_MAPPING_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "operation_id":"OBPv4.0.0-dynamicEndpoint_GET_pet_PET_ID", "request_mapping":"{}", "response_mapping":"{}" }
Required Roles:
  • CanGetEndpointMapping - 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-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getEndpointMapping, operation_id: OBPv4.0.0-getEndpointMapping Tags: Endpoint-Mapping, New-Style,

Get all Endpoint Mappings

Get all Endpoint Mappings.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "endpoint-mappings":[{ "endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "operation_id":"OBPv4.0.0-dynamicEndpoint_GET_pet_PET_ID", "request_mapping":"{}", "response_mapping":"{}" }] }
Required Roles:
  • CanGetAllEndpointMappings - 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-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getAllEndpointMappings, operation_id: OBPv4.0.0-getAllEndpointMappings Tags: Endpoint-Mapping, New-Style,

Update Endpoint Mapping

Update an Endpoint Mapping.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50", "operation_id":"OBPv4.0.0-dynamicEndpoint_GET_pet_PET_ID", "request_mapping":"{}", "response_mapping":"{}" }
Required Roles:
  • CanUpdateEndpointMapping - 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 updateEndpointMapping, operation_id: OBPv4.0.0-updateEndpointMapping Tags: Endpoint-Mapping, New-Style,