-
API
-
Get API Configuration
-
Get API Info (root)
-
Get Adapter Info
-
Get Adapter Info for a bank
-
Get Connector Status (Loopback)
-
Get JSON Web Key (JWK)
-
Get JSON Web Key (JWK) URIs
-
Get Mapper Database Info
-
Get Rate Limiting Info
-
Get the Call Context of a current call
-
Get API Configuration
-
Account
-
Consumer
-
Enable or Disable Consumers
-
Get Consumer
-
Get Consumers
-
Get Consumers (logged in User)
-
Update Consumer RedirectUrl
-
Enable or Disable Consumers
-
Documentation
-
Get Message Docs
-
Get Message Docs Swagger
-
Get Resource Docs
-
Get Swagger documentation
-
Get scanned API Versions
-
Get Message Docs
-
Dynamic Endpoint (Manage)
-
Create Dynamic Endpoint
-
Delete Dynamic Endpoint
-
Get Dynamic Endpoint
-
Get Dynamic Endpoints
-
Delete My Dynamic Endpoint
-
Get My Dynamic Endpoints
-
Create Dynamic Endpoint
-
Dynamic Entity (Manage)
-
Create Dynamic Entity
-
Delete Dynamic Entity
-
Delete My Dynamic Entity
-
Get Bank Level Dynamic Entities
-
Get Dynamic Entities
-
Get My Dynamic Entities
-
Update Dynamic Entity
-
Update My Dynamic Entity
-
Create Dynamic Entity
-
Example Title
-
Method Routing
-
Metric
-
Product
-
Sandbox
-
Swagger Call getBanks
-
Transaction
-
User
-
WebUi Props
-
_CreditApplicationForm
-
Create new Credit Application Form
-
Delete Credit Application Form by id
-
Get Credit Application Form List
-
Get Credit Application Form by id
-
Update Credit Application Form
-
Create new Credit Application Form
-
_TESTING
v4.0.0 filtered by tag: API, API-Role, API-Metrics, API-Documentation (65 APIs)
Get API Configuration
Returns information about:
- The default bank_id
- Akka configuration
- Elastic Search configuration
- Cached functions
Authentication is Mandatory
JSON response body fields:
- value: 5987953
{
"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"]
}
}
-
CanGetConfig
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get API Info (root)
Returns information about:
- API version
- Hosted by information
- Hosted at information
- Energy source information
- Git Commit
Authentication is Optional
JSON response body fields:
-
git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
{
"version":"String",
"version_status":"String",
"git_commit":"String",
"connector":"String",
"hosted_by":{
"organisation":"String",
"email":"String",
"phone":"String",
"organisation_website":"String"
},
"hosted_at":{
"organisation":"Amazon",
"organisation_website":"https://aws.amazon.com/"
},
"energy_source":{
"organisation":"Stromio",
"organisation_website":"https://www.stromio.de/"
}
}
- OBP-50000: Unknown Error.
- no connector set
Get Adapter Info
Get basic information about the Adapter.
Authentication is Optional
JSON response body fields:
-
date: 2020-01-27
-
git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
{
"name":"String",
"version":"String",
"git_commit":"String",
"date":"2013-01-21T23:08:00Z"
}
- OBP-50000: Unknown Error.
Get Adapter Info for a bank
Get basic information about the Adapter listening on behalf of this bank.
Authentication is Optional
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
-
date: 2020-01-27
-
git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
{
"name":"String",
"version":"String",
"git_commit":"String",
"date":"2013-01-21T23:08:00Z"
}
- OBP-50000: Unknown Error.
Get Connector Status (Loopback)
This endpoint makes a call to the Connector to check the backend transport (e.g. Kafka) is reachable.
Currently this is only implemented for Kafka based connectors.
For Kafka based connectors, this endpoint writes a message to Kafka and reads it again.
In the future, this endpoint may also return information about database connections etc.
Authentication is Mandatory
JSON response body fields:
- git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
{
"connector_version":"kafka_vSept2018",
"git_commit":"f0acd4be14cdcb94be3433ec95c1ad65228812a0",
"duration_time":"10 ms"
}
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
Get JSON Web Key (JWK)
Get the server's public JSON Web Key (JWK) set and certificate chain.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.
Authentication is Optional
JSON response body fields:
{
"kty":"RSA",
"e":"AQAB",
"use":"sig",
"kid":"fr6-BxXH5gikFeZ2O6rGk0LUmJpukeswASN_TMW8U_s",
"n":"hrB0OWqg6AeNU3WCnhheG18R5EbQtdNYGOaSeylTjkj2lZr0_vkhNVYvase-CroxO4HOT06InxTYwLnmJiyv2cZxReuoVjTlk--olGu-9MZooiFiqWez0JzndyKxQ27OiAjFsMh0P04kaUXeHKhXRfiU7K2FqBshR1UlnWe7iHLkq2p9rrGjxQc7ff0w-Uc0f-8PWg36Y2Od7s65493iVQwnI13egqMaSvgB1s8_dgm08noEjhr8C5m1aKmr5oipWEPNi-SBV2VNuiCLR1IEPuXq0tOwwZfv31t34KPO-2H2bbaWmzGJy9mMOGqoNrbXyGiUZoyeHRELaNtm1GilyQ"
}
- OBP-50000: Unknown Error.
Get JSON Web Key (JWK) URIs
Get the OAuth2 server's public JSON Web Key (JWK) URIs.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.
Authentication is Optional
JSON response body fields:
{
"jwks_uris":[{
"jwks_uri":"https://www.googleapis.com/oauth2/v3/certs"
}]
}
- OBP-50000: Unknown Error.
Get Mapper Database Info
Get basic information about the Mapper Database.
Authentication is Mandatory
JSON response body fields:
-
date: 2020-01-27
-
git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
{
"name":"String",
"version":"String",
"git_commit":"String",
"date":"2013-01-21T23:08:00Z"
}
-
CanGetDatabaseInfo
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Rate Limiting Info
Get information about the Rate Limiting setup on this OBP Instance such as:
Is rate limiting enabled and active?
What backend is used to keep track of the API calls (e.g. REDIS).
Authentication is Mandatory
JSON response body fields:
- enabled: true
{
"enabled":true,
"technology":"REDIS",
"service_available":true,
"is_active":true
}
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
Get the Call Context of a current call
Get the Call Context of the current call.
Authentication is Mandatory
JSON response body fields:
{
"jsonString":"{}"
}
-
CanGetCallContext
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Delete Account Cascade
Delete an Account Cascade specified by ACCOUNT_ID.
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
JSON response body fields:
{
"jsonString":"{}"
}
-
CanDeleteAccountCascade
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
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: true
{
"enabled":false
}
-
CanEnableConsumers
- Please login to request this Role
-
CanDisableConsumers
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
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:
-
consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
enabled: true
-
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
-
username: felixsmith
{
"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":"2017-09-19T00:00:00Z"
}
-
CanGetConsumers
- Please login to request this Role
- 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.
Get Consumers
Get the all Consumers.
Authentication is Mandatory
JSON response body fields:
-
consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
enabled: true
-
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
-
username: felixsmith
{
"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":"2017-09-19T00:00:00Z"
}]
}
-
CanGetConsumers
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Consumers (logged in User)
Get the Consumers for logged in User.
Authentication is Mandatory
JSON response body fields:
-
consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
enabled: true
-
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
-
username: felixsmith
{
"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":"2017-09-19T00:00:00Z"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
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:
-
consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
enabled: true
-
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
-
username: felixsmith
{
"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":"2017-09-19T00:00:00Z"
}
-
CanUpdateConsumerRedirectUrl
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
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.
Note: API Explorer provides a Message Docs page where these messages are displayed.
CONNECTOR
:kafka_vMar2017 , kafka_vJune2017, kafka_vSept2018, stored_procedure_vDec2019 ...
Authentication is Optional
URL Parameters:
JSON response body fields:
- data.bankId: data.bankId
{
"message_docs":[{
"process":"getAccounts",
"message_format":"KafkaV2017",
"outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts",
"inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts",
"description":"get Banks",
"example_outbound_message":{
"jsonString":"{}"
},
"example_inbound_message":{
"jsonString":"{}"
},
"outboundAvroSchema":{
"jsonString":"{}"
},
"inboundAvroSchema":{
"jsonString":"{}"
},
"adapter_implementation":{
"group":"CORE",
"suggested_order":3
},
"dependent_endpoints":[{
"name":"getAccounts",
"version":"OBPv3.0.0"
},{
"name":"getBalances",
"version":"OBPv2.0.0"
}],
"requiredFieldInfo":{
"data.bankId":["v2.2.0","v3.1.0"]
}
}]
}
- OBP-50000: Unknown Error.
Get Message Docs Swagger
This endpoint provides example message docs in swagger format.
It is only relavent for REST Connectors.
This endpoint can be used by the developer building a REST Adapter that connects to the Core Banking System (CBS).
That is, the Adapter developer can use the Swagger surfaced here to build the REST APIs that the OBP REST connector will call to consume CBS services.
i.e.:
OBP API (Core OBP API code) -> OBP REST Connector (OBP REST Connector code) -> OBP REST Adapter (Adapter developer code) -> CBS (Main Frame)
Authentication is Optional
URL Parameters:
JSON response body fields:
- data.bankId: data.bankId
{
"message_docs":[{
"process":"getAccounts",
"message_format":"KafkaV2017",
"outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts",
"inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts",
"description":"get Banks",
"example_outbound_message":{
"jsonString":"{}"
},
"example_inbound_message":{
"jsonString":"{}"
},
"outboundAvroSchema":{
"jsonString":"{}"
},
"inboundAvroSchema":{
"jsonString":"{}"
},
"adapter_implementation":{
"group":"CORE",
"suggested_order":3
},
"dependent_endpoints":[{
"name":"getAccounts",
"version":"OBPv3.0.0"
},{
"name":"getBalances",
"version":"OBPv2.0.0"
}],
"requiredFieldInfo":{
"data.bankId":["v2.2.0","v3.1.0"]
}
}]
}
- OBP-50000: Unknown Error.
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.
You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.
You may need some other language resource docs, now we support en and zh , e.g. ?language=zh
See the Resource Doc endpoint for more information.
Following are more examples:
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/obp
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/obp?tags=Account,Bank
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/obp?functions=getBanks,bankById
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v4.0.0/obp?language=zh
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
- 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. It contains the standard prefix (e.g. /obp) and the implemented version (the version where this endpoint was defined) e.g. /obp/v1.2.0/resource
- specified_url (recommended to use) is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the version specified in the call e.g. /obp/v3.1.0/resource. In OBP, endpoints are first made available at the request_url, but the same resource (function call) is often made available under later versions (specified_url). To access the latest version of all endpoints use the latest version available on your OBP instance e.g. /obp/v3.1.0 - To get the original version use the request_url. We recommend to use the specified_url since non semantic improvements are more likely to be applied to later implementations of the call.
- summary is a short description inline with the swagger terminology.
- description may contain html markup (generated from markdown on the server).
Authentication is Optional
URL Parameters:
JSON response body fields:
{
"jsonString":"{}"
}
- OBP-50000: Unknown Error.
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=getBanks,bankById
(Each endpoint is implemented in the OBP Scala code by a 'function')
See the Resource Doc endpoint for more information.
Following are more examples:
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById
Authentication is Optional
URL Parameters:
JSON response body fields:
{
"jsonString":"{}"
}
- OBP-50000: Unknown Error.
Get scanned API Versions
Get all the scanned API Versions.
Authentication is Optional
JSON response body fields:
-
apiShortVersion: apiShortVersion
-
apiStandard: apiStandard
-
scanned_api_versions: scanned_api_versions
-
urlPrefix: urlPrefix
{
"scanned_api_versions":[{
"urlPrefix":"obp",
"apiStandard":"obp",
"apiShortVersion":"v3.1.0",
"API_VERSION":"v3.1.0"
}]
}
- OBP-50000: Unknown Error.
Create Dynamic Endpoint
Create dynamic endpoints.
Create dynamic endpoints with one json format swagger content.
If the host of swagger is obp_mock
, every dynamic endpoint will return example response of swagger,
when create MethodRouting for given dynamic endpoint, it will be routed to given url.
Authentication is Mandatory