API Explorer

v3.0.0 (164 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get API Configuration

Returns information about:

  • API Config
  • Akka ports
  • Elastic search ports
  • Cached function

Authentication is Mandatory

Typical Successful Response:

								
									
{ "akka":{ "ports":[{ "property":"default", "value":"8080" }], "log_level":"Debug", "remote_data_secret_matched":true }, "elastic_search":{ "metrics":[{ "property":"String", "value":"Mapper" }], "warehouse":[{ "property":"String", "value":"ElasticSearch" }] }, "cache":[{ "function_name":"getBanks", "ttl_in_seconds":5 }], "scopes":{ "require_scopes_for_all_roles":true, "require_scopes_for_listed_roles":["CanCreateUserAuthContextUpdate"] } }
Required Roles:
  • CanGetConfig - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented in OBPv2.2.0 by config

Get API Info (root)

Returns information about:

  • API version
  • Hosted by information
  • Git Commit

Authentication is Optional

Typical Successful Response:

								
									
{ "version":"String", "version_status":"String", "git_commit":"String", "connector":"String", "hosted_by":{ "organisation":"String", "email":"String", "phone":"String", "organisation_website":"String" } }
Possible Errors:
  • OBP-50000: Unknown Error.
  • no connector set
Implemented in OBPv1.2.1 by root

Get Adapter Info for a bank

Get basic information about the Adapter listening on behalf of this bank.

Authentication is Optional

Typical Successful Response:

								
									
{ "name":"String", "version":"String", "git_commit":"String", "date":"2013-01-21T23:08:00Z" }
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.0.0 by getAdapterInfoForBank