right logo image
right logo image
Log on
⯆

API Explorer

Log off

v4.0.0 (456 APIs)

API Host: https://api3.openbankproject.com
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,
  "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, New-Style,

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

Create My Api Collection Endpoint By Id

Create Api Collection Endpoint By Id.

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

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

Delete My Api Collection Endpoint

Delete Api Collection Endpoint By OPERATION_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:
Version: OBPv4.0.0, function_name: by deleteMyApiCollectionEndpoint, operation_id: OBPv4.0.0-deleteMyApiCollectionEndpoint Tags: Api-Collection, New-Style,

Delete My Api Collection Endpoint By Id

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

Delete My Api Collection Endpoint By Id

Delete Api Collection Endpoint By OPERATION_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:
Version: OBPv4.0.0, function_name: by deleteMyApiCollectionEndpointByOperationId, operation_id: OBPv4.0.0-deleteMyApiCollectionEndpointByOperationId Tags: Api-Collection, New-Style,

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

Get Api Collections

Get Api Collections.

Authentication is Mandatory

URL Parameters:

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

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,
    "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-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 getApiCollections, operation_id: OBPv4.0.0-getApiCollections Tags: Api-Collection, New-Style,

Get Featured Api Collections

Get Featured Api Collections.

Authentication is Optional

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,
    "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, New-Style,

Get My Api Collection By Id

Get Api Collection By API_COLLECTION_ID.

Authentication is Mandatory

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,
  "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, New-Style,

Get My Api Collection By Name

Get Api Collection By API_COLLECTION_NAME.

Authentication is Mandatory

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,
  "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, New-Style,

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

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

Get My Api Collection Endpoints By Id

Get Api Collection Endpoints By API_COLLECTION_ID.

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

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,
    "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, New-Style,

Get Sharable Api Collection By Id

Get Sharable 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,
  "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, New-Style,