API Explorer

v3.1.0 (327 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Enable or Disable Consumers

Enable/Disable a Consumer specified by CONSUMER_ID.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

enabled: false

Typical Successful Response:

								
									
{ "enabled":false }
Required Roles:
  • CanEnableConsumers - Please login to request this Role
  • CanDisableConsumers - 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: OBPv3.1.0, function_name: by enableDisableConsumers, operation_id: OBPv3.1.0-enableDisableConsumers Tags: Consumer,

Get Call Limits for a Consumer

Get Calls limits per Consumer.
Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

per_day_call_limit:

per_hour_call_limit:

per_minute_call_limit:

per_month_call_limit:

per_second_call_limit: 10

per_week_call_limit:

calls_made: 50

current_state:

per_day: 4000

per_hour:

per_minute:

per_month: 500

per_second: 1000

per_week: 50000

reset_in_seconds:

Typical Successful Response:

								
									
{ "per_second_call_limit":"-1", "per_minute_call_limit":"-1", "per_hour_call_limit":"-1", "per_day_call_limit":"-1", "per_week_call_limit":"-1", "per_month_call_limit":"-1", "current_state":{ "per_second":{ "calls_made":-1, "reset_in_seconds":-1 }, "per_minute":{ "calls_made":-1, "reset_in_seconds":-1 }, "per_hour":{ "calls_made":-1, "reset_in_seconds":-1 }, "per_day":{ "calls_made":-1, "reset_in_seconds":-1 }, "per_week":{ "calls_made":-1, "reset_in_seconds":-1 }, "per_month":{ "calls_made":-1, "reset_in_seconds":-1 } } }
Required Roles:
  • CanSetCallLimits - 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-10001: Incorrect json format.
  • OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30023: Cannot update Consumer
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getCallsLimit, operation_id: OBPv3.1.0-getCallsLimit Tags: Consumer,

Get Consumer

Get the Consumer specified by CONSUMER_ID.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

app_name: appNameBank

app_type: Web

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

created:

created_by_user:

created_by_user_id:

description: Description of the object. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: false

provider: ETHEREUM

provider_id:

redirect_url: https://apisandbox.openbankproject.com

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

username: felixsmith

Typical Successful Response:

								
									
{ "consumer_id":1213, "app_name":"SOFI", "app_type":"Web", "description":"Account Management", "developer_email":"felixsmith@example.com", "redirect_url":"www.openbankproject.com", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "created_by_user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"felixsmith@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "enabled":true, "created":"1100-01-01T00:00:00Z" }
Required Roles:
  • CanGetConsumers - 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-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getConsumer, operation_id: OBPv3.1.0-getConsumer Tags: Consumer,

Get Consumers

Get the all Consumers.

Authentication is Mandatory

Possible custom url parameters for pagination:

  • limit=NUMBER ==> default value: 50
  • offset=NUMBER ==> default value: 0

eg1:?limit=100&offset=0

  • sort_direction=ASC/DESC ==> default value: DESC.

eg2:?limit=100&offset=0&sort_direction=ASC

  • from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).
  • to_date=DATE => example value: 2024-12-04T12:22:00.737Z. NOTE! The default value is now (2024-12-04T12:22:00.737Z).

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z

JSON response body fields:

app_name: appNameBank

app_type: Web

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

consumers:

created:

created_by_user:

description: Description of the object. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: false

provider: ETHEREUM

provider_id:

redirect_url: https://apisandbox.openbankproject.com

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

username: felixsmith

Typical Successful Response:

								
									
{ "consumers":[{ "consumer_id":"8e716299-4668-4efd-976a-67f57a9984ec", "app_name":"SOFI", "app_type":"Web", "description":"Account Management", "developer_email":"felixsmith@example.com", "redirect_url":"www.openbankproject.com", "created_by_user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"felixsmith@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "enabled":true, "created":"1100-01-01T00:00:00Z" }] }
Required Roles:
  • CanGetConsumers - 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: OBPv3.1.0, function_name: by getConsumers, operation_id: OBPv3.1.0-getConsumers Tags: Consumer,

Get Consumers (logged in User)

Get the Consumers for logged in User.

Authentication is Mandatory

JSON response body fields:

app_name: appNameBank

app_type: Web

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

consumers:

created:

created_by_user:

description: Description of the object. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: false

provider: ETHEREUM

provider_id:

redirect_url: https://apisandbox.openbankproject.com

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

username: felixsmith

Typical Successful Response:

								
									
{ "consumers":[{ "consumer_id":"8e716299-4668-4efd-976a-67f57a9984ec", "app_name":"SOFI", "app_type":"Web", "description":"Account Management", "developer_email":"felixsmith@example.com", "redirect_url":"www.openbankproject.com", "created_by_user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"felixsmith@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "enabled":true, "created":"1100-01-01T00:00:00Z" }] }
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: OBPv3.1.0, function_name: by getConsumersForCurrentUser, operation_id: OBPv3.1.0-getConsumersForCurrentUser Tags: Consumer,

Set Rate Limiting (call limits) per Consumer

Set the API rate limiting (call limits) per Consumer:

Call limits can be set:

Per Second
Per Minute
Per Hour
Per Week
Per Month

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

from_date:

per_day_call_limit:

per_hour_call_limit:

per_minute_call_limit:

per_month_call_limit:

per_second_call_limit: 10

per_week_call_limit:

to_date:

Typical Successful Response:

								
									
{ "from_date":"1100-01-01T00:00:00Z", "to_date":"1100-01-01T00:00:00Z", "per_second_call_limit":"-1", "per_minute_call_limit":"-1", "per_hour_call_limit":"-1", "per_day_call_limit":"-1", "per_week_call_limit":"-1", "per_month_call_limit":"-1" }
Required Roles:
  • CanSetCallLimits - 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-10001: Incorrect json format.
  • OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30023: Cannot update Consumer
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by callsLimit, operation_id: OBPv3.1.0-callsLimit Tags: Consumer,

Update Consumer RedirectUrl

Update an existing redirectUrl for a Consumer specified by CONSUMER_ID.

CONSUMER_ID can be obtained after you register the application.

Or use the endpoint 'Get Consumers' to get it

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

app_name: appNameBank

app_type: Web

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

created:

created_by_user:

created_by_user_id:

description: Description of the object. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: false

provider: ETHEREUM

provider_id:

redirect_url: https://apisandbox.openbankproject.com

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

username: felixsmith

Typical Successful Response:

								
									
{ "consumer_id":1213, "app_name":"SOFI", "app_type":"Web", "description":"Account Management", "developer_email":"felixsmith@example.com", "redirect_url":"www.openbankproject.com", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "created_by_user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"felixsmith@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "enabled":true, "created":"1100-01-01T00:00:00Z" }
Required Roles:
  • CanUpdateConsumerRedirectUrl - 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: OBPv2.1.0, function_name: by updateConsumerRedirectUrl, operation_id: OBPv2.1.0-updateConsumerRedirectUrl Tags: Consumer,