API Explorer

v5.1.0 (516 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create My Api Collection

Create Api Collection for logged in user.

Authentication is Mandatory

JSON request body fields:

api_collection_name: Favourites

is_sharable: is_sharable

description: This an optional field. Maximum length is 2000. It can be any characters here.

JSON response body fields:

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

api_collection_name: Favourites

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

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, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }
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:
Version: OBPv4.0.0, function_name: by createMyApiCollection, operation_id: OBPv4.0.0-createMyApiCollection Tags: Api-Collection,

Create My Api Collection Endpoint

Create Api Collection Endpoint.

glossary-item-not-found

Authentication is Mandatory

URL Parameters:

API_COLLECTION_NAME: Favourites

JSON request body fields:

operation_id: OBPv4.0.0-getBanks

JSON response body fields:

api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

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

operation_id: OBPv4.0.0-getBanks

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:
Version: OBPv4.0.0, function_name: by createMyApiCollectionEndpoint, operation_id: OBPv4.0.0-createMyApiCollectionEndpoint Tags: Api-Collection,

Create My Api Collection Endpoint By Id

Create Api Collection Endpoint By Id.

glossary-item-not-found

Authentication is Mandatory

URL Parameters:

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

JSON request body fields:

operation_id: OBPv4.0.0-getBanks

JSON response body fields:

api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

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

operation_id: OBPv4.0.0-getBanks

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:
Version: OBPv4.0.0, function_name: by createMyApiCollectionEndpointById, operation_id: OBPv4.0.0-createMyApiCollectionEndpointById Tags: Api-Collection,

Delete My Api Collection

Delete Api Collection By API_COLLECTION_ID

glossary-item-not-found

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

Typical Successful Response:

								
									
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:
Version: OBPv4.0.0, function_name: by deleteMyApiCollection, operation_id: OBPv4.0.0-deleteMyApiCollection Tags: Api-Collection,

Delete My Api Collection Endpoint

glossary-item-not-found

Delete Api Collection Endpoint By OPERATION_ID

Authentication is Mandatory

URL Parameters:

API_COLLECTION_NAME: Favourites

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

Typical Successful Response:

								
									
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:
Version: OBPv4.0.0, function_name: by deleteMyApiCollectionEndpoint, operation_id: OBPv4.0.0-deleteMyApiCollectionEndpoint Tags: Api-Collection,

Delete My Api Collection Endpoint By Id

glossary-item-not-found

Delete Api Collection Endpoint By OPERATION_ID

Authentication is Mandatory

URL Parameters:

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

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

Typical Successful Response:

								
									
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:
Version: OBPv4.0.0, function_name: by deleteMyApiCollectionEndpointByOperationId, operation_id: OBPv4.0.0-deleteMyApiCollectionEndpointByOperationId Tags: Api-Collection,

Delete My Api Collection Endpoint By Id

glossary-item-not-found
Delete Api Collection Endpoint
Delete Api Collection Endpoint By Id

Authentication is Mandatory

URL Parameters:

API_COLLECTION_ENDPOINT_ID: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

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

JSON response body fields:

Typical Successful Response:

								
									
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:
Version: OBPv4.0.0, function_name: by deleteMyApiCollectionEndpointById, operation_id: OBPv4.0.0-deleteMyApiCollectionEndpointById Tags: Api-Collection,

Get All API Collections

Get All API Collections.

Authentication is Mandatory

JSON response body fields:

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

api_collection_name: Favourites

api_collections: api_collections

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

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, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }] }
Required Roles:
  • CanGetAllApiCollections - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Connector Methods:
Version: OBPv5.1.0, function_name: by getAllApiCollections, operation_id: OBPv5.1.0-getAllApiCollections Tags: Api-Collection,

Get Api Collection Endpoints

Get Api Collection Endpoints By API_COLLECTION_ID.

Authentication is Optional

URL Parameters:

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

JSON response body fields:

api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

api_collection_endpoints: api_collection_endpoints

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

operation_id: OBPv4.0.0-getBanks

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:
Version: OBPv4.0.0, function_name: by getApiCollectionEndpoints, operation_id: OBPv4.0.0-getApiCollectionEndpoints Tags: Api-Collection,

Get Api Collections for User

Get Api Collections for User.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

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

api_collection_name: Favourites

api_collections: api_collections

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

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, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }] }
Required Roles:
  • CanGetApiCollectionsForUser - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by getApiCollectionsForUser, operation_id: OBPv4.0.0-getApiCollectionsForUser Tags: Api-Collection,

Get Featured Api Collections

Get Featured Api Collections.

Authentication is Optional

JSON response body fields:

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

api_collection_name: Favourites

api_collections: api_collections

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

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, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getFeaturedApiCollections, operation_id: OBPv4.0.0-getFeaturedApiCollections Tags: Api-Collection,

Get My Api Collection By Id

Get Api Collection By API_COLLECTION_ID.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

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

api_collection_name: Favourites

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

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, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }
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:
Version: OBPv4.0.0, function_name: by getMyApiCollectionById, operation_id: OBPv4.0.0-getMyApiCollectionById Tags: Api-Collection,

Get My Api Collection By Name

Get Api Collection By API_COLLECTION_NAME.

Authentication is Mandatory

URL Parameters:

API_COLLECTION_NAME: Favourites

JSON response body fields:

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

api_collection_name: Favourites

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

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, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }
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:
Version: OBPv4.0.0, function_name: by getMyApiCollectionByName, operation_id: OBPv4.0.0-getMyApiCollectionByName Tags: Api-Collection,

Get My Api Collection Endpoint

Get Api Collection Endpoint By API_COLLECTION_NAME and OPERATION_ID.

Authentication is Optional

URL Parameters:

API_COLLECTION_NAME: Favourites

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

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

operation_id: OBPv4.0.0-getBanks

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:
Version: OBPv4.0.0, function_name: by getMyApiCollectionEndpoint, operation_id: OBPv4.0.0-getMyApiCollectionEndpoint Tags: Api-Collection,

Get My Api Collection Endpoints

Get Api Collection Endpoints By API_COLLECTION_NAME.

Authentication is Mandatory

URL Parameters:

API_COLLECTION_NAME: Favourites

JSON response body fields:

api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

api_collection_endpoints: api_collection_endpoints

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

operation_id: OBPv4.0.0-getBanks

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:
Version: OBPv4.0.0, function_name: by getMyApiCollectionEndpoints, operation_id: OBPv4.0.0-getMyApiCollectionEndpoints Tags: Api-Collection,

Get My Api Collection Endpoints By Id

Get Api Collection Endpoints By API_COLLECTION_ID.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

api_collection_endpoints: api_collection_endpoints

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

operation_id: OBPv4.0.0-getBanks

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:
Version: OBPv4.0.0, function_name: by getMyApiCollectionEndpointsById, operation_id: OBPv4.0.0-getMyApiCollectionEndpointsById Tags: Api-Collection,

Get My Api Collections

Get all the apiCollections for logged in user.

Authentication is Mandatory

JSON response body fields:

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

api_collection_name: Favourites

api_collections: api_collections

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

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, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getMyApiCollections, operation_id: OBPv4.0.0-getMyApiCollections Tags: Api-Collection,

Get Sharable Api Collection By Id

Get Sharable Api Collection By Id.
Authentication is Optional

URL Parameters:

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

JSON response body fields:

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

api_collection_name: Favourites

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

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, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getSharableApiCollectionById, operation_id: OBPv4.0.0-getSharableApiCollectionById Tags: Api-Collection,

Update My Api Collection By API_COLLECTION_ID

Update Api Collection for logged in user.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

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

api_collection_name: Favourites

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

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, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }
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:
Version: OBPv5.1.0, function_name: by updateMyApiCollection, operation_id: OBPv5.1.0-updateMyApiCollection Tags: Api-Collection,