API Explorer

PSD2 APIs v3.1.0 filtered by tag: API, API-Role, API-Metrics, API-Documentation (7)

Bank

Accounts

Views

Counterparties

Transactions

Get API Configuration

Returns information about:

  • API Config
  • Akka ports
  • Elastic search ports
  • Cached function
Typical Successful Response:

								
									
{ "akka":{ "ports":[{ "property":"default", "value":"8080" }], "log_level":"Debug" }, "elastic_search":{ "metrics":[{ "property":"String", "value":"Mapper" }], "warehouse":[{ "property":"String", "value":"ElasticSearch" }] }, "cache":[{ "function_name":"getBanks", "ttl_in_seconds":5 }] }
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.
Implmented in 2_2_0 by config

Get API Info (root)

Returns information about:

  • API version
  • Hosted by information
  • Git Commit
Typical Successful Response:

								
									
{ "version":"String", "version_status":"String", "git_commit":"String", "connector":"String", "hosted_by":{ "organisation":"String", "email":"String", "phone":"String", "organisation_website":"String" }, "akka":{ "remote_data_secret_matched":true } }
Possible Errors:
  • OBP-50000: Unknown Error.
  • no connector set
Implmented in 1_2_1 by root

Get Adapter Info

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "name":"String", "version":"String", "git_commit":"String", "date":"2013-01-21T23:08:00Z" }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by getAdapter

Get API Glossary

Returns the glossary of the API

Typical Successful Response:

								
									
{ "glossary_items":[{ "title":"Title ", "description":{ "markdown":"\nDescription.\n\nGoes here..\n ", "html":"<p>Description.</p>\n<p>Goes here..</p>" } }] }
Possible Errors:
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by glossary

Get Message Docs

These message docs provide example messages sent by OBP to the (Kafka) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes. Integrators can use these messages to build Adapters that provide core banking services to OBP.

CONNECTOR: kafka_vJuneYellow2017, kafka_vJune2017 , kafka_vMar2017 or ...

Typical Successful Response:

								
									
{ "messageDocs":[{ "process":"getBanks", "message_format":"KafkaV2017", "description":"get Banks", "example_outbound_message":{ "jsonString":"{}" }, "example_inbound_message":{ "jsonString":"{}" }, "outboundAvroSchema":{ "jsonString":"{}" }, "inboundAvroSchema":{ "jsonString":"{}" } }] }
Possible Errors:
  • OBP-50000: Unknown Error.
Implmented in 2_2_0 by getMessageDocs

Get Resource Docs.

Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.

This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.

This endpoint is used by OBP API Explorer to display and work with the API documentation.

Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank

You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics

For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.

  • operation_id is concatenation of "v", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code)
  • version references the version that the API call is defined in.
  • function is the (scala) partial function that implements this endpoint. It is unique per version of the API.
  • request_url is empty for the root call, else the path.
  • summary is a short description inline with the swagger terminology.
  • description may contain html markup (generated from markdown on the server).
Typical Successful Response:

								
									
{ "jsonString":"{}" }
Possible Errors:
  • OBP-50000: Unknown Error.
Implmented in 1_4_0 by getResourceDocsObp

Get Swagger documentation

Returns documentation about the RESTful resources on this server in Swagger format.

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank

(All endpoints are given one or more tags which for used in grouping)

You may filter this endpoint using the 'functions' url parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics

(Each endpoint is implemented in the OBP Scala code by a 'function')

See the Resource Doc endpoint for more information.

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Possible Errors:
  • OBP-50000: Unknown Error.
Implmented in 1_4_0 by getResourceDocsSwagger