API Explorer

v4.0.0 (397 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create My Api Collection

Create Api Collection for logged in user.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "api_collection_name":"Favourites", "is_sharable":true }
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-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by createMyApiCollection, operation_id: OBPv4.0.0-createMyApiCollection

Create My Api Collection Endpoint

Create Api Collection Endpoint.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks" }
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:
Implemented in OBPv4.0.0 by createMyApiCollectionEndpoint, operation_id: OBPv4.0.0-createMyApiCollectionEndpoint

Delete My Api Collection

Delete Api Collection By API_COLLECTION_ID

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "value":true }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by deleteMyApiCollection, operation_id: OBPv4.0.0-deleteMyApiCollection

Delete My Api Collection Endpoint

Delete Api Collection Endpoint By Id

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "value":true }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by deleteMyApiCollectionEndpoint, operation_id: OBPv4.0.0-deleteMyApiCollectionEndpoint

Get Api Collection By Id

Get Api Collection By Id.

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "api_collection_name":"Favourites", "is_sharable":true }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by getApiCollectionById, operation_id: OBPv4.0.0-getApiCollectionById

Get Api Collection Endpoints

Get Api Collection Endpoints By API_COLLECTION_ID.

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "api_collection_endpoints":[{ "api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by getApiCollectionEndpoints, operation_id: OBPv4.0.0-getApiCollectionEndpoints

Get Api Collections

Get Api Collections.

Authentication is Optional

URL Parameters:

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

JSON response body fields:

Typical Successful Response:

								
									
{ "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "api_collection_name":"Favourites", "is_sharable":true }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by getApiCollections, operation_id: OBPv4.0.0-getApiCollections

Get My Api Collection By Name

Get Api Collection By API_COLLECTION_NAME.

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "api_collection_name":"Favourites", "is_sharable":true }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by getMyApiCollectionByName, operation_id: OBPv4.0.0-getMyApiCollectionByName

Get My Api Collection Endpoint

Get Api Collection Endpoint By API_COLLECTION_NAME and OPERATION_ID.

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by getMyApiCollectionEndpoint, operation_id: OBPv4.0.0-getMyApiCollectionEndpoint

Get My Api Collection Endpoints

Get Api Collection Endpoints By API_COLLECTION_NAME.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "api_collection_endpoints":[{ "api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by getMyApiCollectionEndpoints, operation_id: OBPv4.0.0-getMyApiCollectionEndpoints

Get My Api Collections

Get all the apiCollections for logged in user.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "api_collections":[{ "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "api_collection_name":"Favourites", "is_sharable":true }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Connector Methods:
Implemented in OBPv4.0.0 by getMyApiCollections, operation_id: OBPv4.0.0-getMyApiCollections