API Explorer

v4.0.0 filtered by tags: API ... (110 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Bank Level Endpoint Tag

Create Bank Level Endpoint Tag

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "bank_id":"gh.29.uk", "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks", "tag_name":"BankAccountTag1" }
Required Roles:
  • CanCreateBankLevelEndpointTag - 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-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Version: OBPv4.0.0, function_name: by createBankLevelEndpointTag, operation_id: OBPv4.0.0-createBankLevelEndpointTag Tags: API, API, New-Style,

Create System Level Endpoint Tag

Create System Level Endpoint Tag

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "bank_id":"gh.29.uk", "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks", "tag_name":"BankAccountTag1" }
Required Roles:
  • CanCreateSystemLevelEndpointTag - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Version: OBPv4.0.0, function_name: by createSystemLevelEndpointTag, operation_id: OBPv4.0.0-createSystemLevelEndpointTag Tags: API, API, New-Style,

Delete Bank Level Endpoint Tag

Delete Bank Level Endpoint Tag.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "value":true }
Required Roles:
  • CanDeleteBankLevelEndpointTag - 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-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Version: OBPv4.0.0, function_name: by deleteBankLevelEndpointTag, operation_id: OBPv4.0.0-deleteBankLevelEndpointTag Tags: API, API, New-Style,

Delete System Level Endpoint Tag

Delete System Level Endpoint Tag.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "value":true }
Required Roles:
  • CanDeleteSystemLevelEndpointTag - 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.
Version: OBPv4.0.0, function_name: by deleteSystemLevelEndpointTag, operation_id: OBPv4.0.0-deleteSystemLevelEndpointTag Tags: API, API, New-Style,

Get API Configuration

Returns information about:

  • The default bank_id
  • Akka configuration
  • Elastic Search configuration
  • Cached functions

Authentication is Mandatory

JSON response body fields:

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
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 config, operation_id: OBPv3.1.0-config Tags: API, New-Style,

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:

Typical Successful Response:

								
									
{ "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/" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
  • no connector set
Connector Methods:
Version: OBPv4.0.0, function_name: by root, operation_id: OBPv4.0.0-root Tags: API, New-Style,

Get Adapter Info

Get basic information about the Adapter.

Authentication is Optional

JSON response body fields:

  • date: 2020-01-27

  • git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

Typical Successful Response:

								
									
{ "name":"String", "version":"String", "git_commit":"String", "date":"2013-01-21T23:08:00Z" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Version: OBPv3.1.0, function_name: by getAdapterInfo, operation_id: OBPv3.1.0-getAdapterInfo Tags: API, New-Style,

Get Adapter Info for a bank

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

Authentication is Optional

URL Parameters:

JSON response body fields:

  • date: 2020-01-27

  • git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

Typical Successful Response:

								
									
{ "name":"String", "version":"String", "git_commit":"String", "date":"2013-01-21T23:08:00Z" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Version: OBPv3.0.0, function_name: by getAdapterInfoForBank, operation_id: OBPv3.0.0-getAdapterInfoForBank Tags: API, New-Style,

Get Bank Level Endpoint Tags

Get Bank Level Endpoint Tags.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
[{ "bank_id":"gh.29.uk", "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks", "tag_name":"BankAccountTag1" }]
Required Roles:
  • CanGetBankLevelEndpointTag - 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-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getBankLevelEndpointTags, operation_id: OBPv4.0.0-getBankLevelEndpointTags Tags: API, API, New-Style,

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
Typical Successful Response:

								
									
{ "connector_version":"kafka_vSept2018", "git_commit":"f0acd4be14cdcb94be3433ec95c1ad65228812a0", "duration_time":"10 ms" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Connector Methods:
Version: OBPv3.1.0, function_name: by getObpConnectorLoopback, operation_id: OBPv3.1.0-getObpConnectorLoopback Tags: API, New-Style,

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:

Typical Successful Response:

								
									
{ "kty":"RSA", "e":"AQAB", "use":"sig", "kid":"fr6-BxXH5gikFeZ2O6rGk0LUmJpukeswASN_TMW8U_s", "n":"hrB0OWqg6AeNU3WCnhheG18R5EbQtdNYGOaSeylTjkj2lZr0_vkhNVYvase-CroxO4HOT06InxTYwLnmJiyv2cZxReuoVjTlk--olGu-9MZooiFiqWez0JzndyKxQ27OiAjFsMh0P04kaUXeHKhXRfiU7K2FqBshR1UlnWe7iHLkq2p9rrGjxQc7ff0w-Uc0f-8PWg36Y2Od7s65493iVQwnI13egqMaSvgB1s8_dgm08noEjhr8C5m1aKmr5oipWEPNi-SBV2VNuiCLR1IEPuXq0tOwwZfv31t34KPO-2H2bbaWmzGJy9mMOGqoNrbXyGiUZoyeHRELaNtm1GilyQ" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getServerJWK, operation_id: OBPv3.1.0-getServerJWK Tags: API, Account Information Service (AIS), PSD2, New-Style,

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:

Typical Successful Response:

								
									
{ "jwks_uris":[{ "jwks_uri":"https://www.googleapis.com/oauth2/v3/certs" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getOAuth2ServerJWKsURIs, operation_id: OBPv3.1.0-getOAuth2ServerJWKsURIs Tags: API, New-Style,

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

Typical Successful Response:

								
									
{ "name":"String", "version":"String", "git_commit":"String", "date":"2013-01-21T23:08:00Z" }
Required Roles:
  • CanGetDatabaseInfo - 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-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by getMapperDatabaseInfo, operation_id: OBPv4.0.0-getMapperDatabaseInfo Tags: API, New-Style,

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:

Typical Successful Response:

								
									
{ "enabled":true, "technology":"REDIS", "service_available":true, "is_active":true }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Connector Methods:
Version: OBPv3.1.0, function_name: by getRateLimitingInfo, operation_id: OBPv3.1.0-getRateLimitingInfo Tags: API, New-Style,

Get System Level Endpoint Tags

Get System Level Endpoint Tags.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
[{ "bank_id":"gh.29.uk", "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks", "tag_name":"BankAccountTag1" }]
Required Roles:
  • CanGetSystemLevelEndpointTag - 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: OBPv4.0.0, function_name: by getSystemLevelEndpointTags, operation_id: OBPv4.0.0-getSystemLevelEndpointTags Tags: API, API, New-Style,

Get the Call Context of a current call

Get the Call Context of the current call.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanGetCallContext - 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-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by getCallContext, operation_id: OBPv4.0.0-getCallContext Tags: API, New-Style,

Update Bank Level Endpoint Tag

Update Endpoint Tag, you can only update the tag_name here, operation_id can not be updated.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "bank_id":"gh.29.uk", "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks", "tag_name":"BankAccountTag1" }
Required Roles:
  • CanUpdateBankLevelEndpointTag - 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-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30099: Invalid ENDPOINT_TAG_ID. Please specify a valid value for ENDPOINT_TAG_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Version: OBPv4.0.0, function_name: by updateBankLevelEndpointTag, operation_id: OBPv4.0.0-updateBankLevelEndpointTag Tags: API, API, New-Style,

Update System Level Endpoint Tag

Update System Level Endpoint Tag, you can only update the tag_name here, operation_id can not be updated.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "bank_id":"gh.29.uk", "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks", "tag_name":"BankAccountTag1" }
Required Roles:
  • CanUpdateSystemLevelEndpointTag - 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-30099: Invalid ENDPOINT_TAG_ID. Please specify a valid value for ENDPOINT_TAG_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Version: OBPv4.0.0, function_name: by updateSystemLevelEndpointTag, operation_id: OBPv4.0.0-updateSystemLevelEndpointTag Tags: API, API, New-Style,

Verify Request and Sign Response of a current call

Verify Request and Sign Response of a current call.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
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 verifyRequestSignResponse, operation_id: OBPv4.0.0-verifyRequestSignResponse Tags: API, New-Style,

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 }
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.

API Collections

An API Collection is a collection of endpoints grouped together for a certain purpose.

Having read access to a Collection does not constitute execute access on the endpoints in the Collection.

(Execute access is governed by Entitlements to Roles - and in some cases, Views.)

Collections can be created and shared. You can make a collection non-sharable but the default is sharable.

Your "Favourites" in API Explorer is actually a collection you control named "Favourites".

To share a Collection (e.g. your Favourites) just click on your Favourites in the API Explorer and share the URL in the browser. If you want to share the Collection via an API, just share the collection_id with a developer.

If you share a Collection it can't be modified by anyone else, but anyone can use it as a basis for their own Favourites or another collection.

There are over 13 endpoints for controlling Collections.
Some of these endpoints require Entitlements to Roles and some operate on your own personal collections such as your favourites.

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,

Delete My Api Collection

Delete Api Collection By API_COLLECTION_ID

API Collections

An API Collection is a collection of endpoints grouped together for a certain purpose.

Having read access to a Collection does not constitute execute access on the endpoints in the Collection.

(Execute access is governed by Entitlements to Roles - and in some cases, Views.)

Collections can be created and shared. You can make a collection non-sharable but the default is sharable.

Your "Favourites" in API Explorer is actually a collection you control named "Favourites".

To share a Collection (e.g. your Favourites) just click on your Favourites in the API Explorer and share the URL in the browser. If you want to share the Collection via an API, just share the collection_id with a developer.

If you share a Collection it can't be modified by anyone else, but anyone can use it as a basis for their own Favourites or another collection.

There are over 13 endpoints for controlling Collections.
Some of these endpoints require Entitlements to Roles and some operate on your own personal collections such as your favourites.

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

API Collections

An API Collection is a collection of endpoints grouped together for a certain purpose.

Having read access to a Collection does not constitute execute access on the endpoints in the Collection.

(Execute access is governed by Entitlements to Roles - and in some cases, Views.)

Collections can be created and shared. You can make a collection non-sharable but the default is sharable.

Your "Favourites" in API Explorer is actually a collection you control named "Favourites".

To share a Collection (e.g. your Favourites) just click on your Favourites in the API Explorer and share the URL in the browser. If you want to share the Collection via an API, just share the collection_id with a developer.

If you share a Collection it can't be modified by anyone else, but anyone can use it as a basis for their own Favourites or another collection.

There are over 13 endpoints for controlling Collections.
Some of these endpoints require Entitlements to Roles and some operate on your own personal collections such as your favourites.

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 deleteMyApiCollectionEndpoint, operation_id: OBPv4.0.0-deleteMyApiCollectionEndpoint 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 }] }
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 }] }
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 }
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 }
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 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 }] }
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 }
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,

Create an Authentication Type Validation

Create an Authentication Type Validation.

Please supply allowed authentication types.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "operation_id":"OBPv4.0.0-updateXxx", "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","OAuth2_OIDC","OAuth2_OIDC_FAPI"] }
Required Roles:
  • CanCreateAuthenticationTypeValidation - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createAuthenticationTypeValidation, operation_id: OBPv4.0.0-createAuthenticationTypeValidation Tags: Authentication-Type-Validation, New-Style,

Delete an Authentication Type Validation

Delete an Authentication Type Validation by operation_id.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
true
Required Roles:
  • CanDeleteAuthenticationValidation - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteAuthenticationTypeValidation, operation_id: OBPv4.0.0-deleteAuthenticationTypeValidation Tags: Authentication-Type-Validation, New-Style,

Get all Authentication Type Validations

Get all Authentication Type Validations.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "authentication_types_validations":[{ "operation_id":"OBPv4.0.0-updateXxx", "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","OAuth2_OIDC","OAuth2_OIDC_FAPI"] }] }
Required Roles:
  • CanGetAuthenticationTypeValidation - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getAllAuthenticationTypeValidations, operation_id: OBPv4.0.0-getAllAuthenticationTypeValidations Tags: Authentication-Type-Validation, New-Style,

Get all Authentication Type Validations - public

Get all Authentication Type Validations - public.

Authentication is Optional

JSON response body fields:

Typical Successful Response:

								
									
{ "authentication_types_validations":[{ "operation_id":"OBPv4.0.0-updateXxx", "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","OAuth2_OIDC","OAuth2_OIDC_FAPI"] }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getAllAuthenticationTypeValidationsPublic, operation_id: OBPv4.0.0-getAllAuthenticationTypeValidationsPublic Tags: Authentication-Type-Validation, New-Style,

Get an Authentication Type Validation

Get an Authentication Type Validation by operation_id.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "operation_id":"OBPv4.0.0-updateXxx", "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","OAuth2_OIDC","OAuth2_OIDC_FAPI"] }
Required Roles:
  • CanGetAuthenticationTypeValidation - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • 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 getAuthenticationTypeValidation, operation_id: OBPv4.0.0-getAuthenticationTypeValidation Tags: Authentication-Type-Validation, New-Style,

Update an Authentication Type Validation

Update an Authentication Type Validation.

Please supply allowed authentication types.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "operation_id":"OBPv4.0.0-updateXxx", "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","OAuth2_OIDC","OAuth2_OIDC_FAPI"] }
Required Roles:
  • CanUpdateAuthenticationTypeValidation - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateAuthenticationTypeValidation, operation_id: OBPv4.0.0-updateAuthenticationTypeValidation Tags: Authentication-Type-Validation, New-Style,

Create Connector Method

Create an internal connector.

The method_body is URL-encoded format String

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51", "method_name":"getBank", "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29" }
Required Roles:
  • CanCreateConnectorMethod - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createConnectorMethod, operation_id: OBPv4.0.0-createConnectorMethod Tags: Connector-Method, New-Style,

Get Connector Method by Id

Get an internal connector by CONNECTOR_METHOD_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51", "method_name":"getBank", "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29" }
Required Roles:
  • CanGetConnectorMethod - 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: OBPv4.0.0, function_name: by getConnectorMethod, operation_id: OBPv4.0.0-getConnectorMethod Tags: Connector-Method, New-Style,

Get all Connector Methods

Get all Connector Methods.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "connectors_methods":[{ "connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51", "method_name":"getBank", "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29" }] }
Required Roles:
  • CanGetAllConnectorMethods - 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: OBPv4.0.0, function_name: by getAllConnectorMethods, operation_id: OBPv4.0.0-getAllConnectorMethods Tags: Connector-Method, New-Style,

Update Connector Method

Update an internal connector.

The method_body is URL-encoded format String

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51", "method_name":"getBank", "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29" }
Required Roles:
  • CanUpdateConnectorMethod - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateConnectorMethod, operation_id: OBPv4.0.0-updateConnectorMethod Tags: Connector-Method, New-Style,

Get Bank Level Dynamic 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

You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.

See the Resource Doc endpoint for more information.

Following are more examples:
https://finx22openplatform.fintech-galaxy.com/obp/v3.1.0/banks/BANK_ID/resource-docs/v3.1.0/obp
https://finx22openplatform.fintech-galaxy.com/obp/v3.1.0/banks/BANK_ID/resource-docs/v3.1.0/obp?tags=Account,Bank
https://finx22openplatform.fintech-galaxy.com/obp/v3.1.0/banks/BANK_ID/resource-docs/v3.1.0/obp?functions=getBanks,bankById
https://finx22openplatform.fintech-galaxy.com/obp/v3.1.0/banks/BANK_ID/resource-docs/v4.0.0/obp?language=zh
https://finx22openplatform.fintech-galaxy.com/obp/v3.1.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://finx22openplatform.fintech-galaxy.com/obp/v3.1.0/banks/BANK_ID/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221

  • 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:

Typical Successful Response:

								
									
{ "resource_docs":[{ "operation_id":"OBPv1.4.0-testResourceDoc", "implemented_by":{ "version":"OBPv1.4.0", "function":"testResourceDoc" }, "request_verb":"GET", "request_url":"/dummy", "summary":"Test Resource Doc", "description":"<p>I am only a test Resource Doc</p>\n<p>Authentication is Optional</p>\n<p><strong>JSON response body fields:</strong></p>\n", "description_markdown":"I am only a test Resource Doc\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n", "example_request_body":{ "jsonString":"{}" }, "success_response_body":{ "jsonString":"{}" }, "error_response_bodies":["OBP-50000: Unknown Error."], "tags":["Documentation"], "typed_request_body":{ "type":"object", "properties":{ "jsonString":{ "type":"string" } } }, "typed_success_response_body":{ "type":"object", "properties":{ "jsonString":{ "type":"string" } } }, "is_featured":false, "special_instructions":"", "specified_url":"", "connector_methods":[] }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Version: OBPv1.4.0, function_name: by getBankLevelDynamicResourceDocsObp, operation_id: OBPv1.4.0-getBankLevelDynamicResourceDocsObp Tags: Documentation, API,

Get Glossary of the API

Get API Glossary

Returns the glossary of the API

Authentication is Optional

JSON response body fields:

Typical Successful Response:

								
									
{ "glossary_items":[{ "title":"Dr.", "description":{ "markdown":"String", "html":"String" } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getApiGlossary, operation_id: OBPv3.0.0-getApiGlossary Tags: Documentation, New-Style,

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:

Typical Successful Response:

								
									
{ "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"] } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.2.0, function_name: by getMessageDocs, operation_id: OBPv2.2.0-getMessageDocs Tags: Documentation, API, New-Style,

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:

Typical Successful Response:

								
									
{ "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"] } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getMessageDocsSwagger, operation_id: OBPv3.1.0-getMessageDocsSwagger Tags: Documentation, API, New-Style,

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

You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.

See the Resource Doc endpoint for more information.

Following are more examples:
https://finx22openplatform.fintech-galaxy.com/obp/v3.1.0/resource-docs/v3.1.0/obp
https://finx22openplatform.fintech-galaxy.com/obp/v3.1.0/resource-docs/v3.1.0/obp?tags=Account,Bank
https://finx22openplatform.fintech-galaxy.com/obp/v3.1.0/resource-docs/v3.1.0/obp?functions=getBanks,bankById
https://finx22openplatform.fintech-galaxy.com/obp/v3.1.0/resource-docs/v4.0.0/obp?language=zh
https://finx22openplatform.fintech-galaxy.com/obp/v3.1.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://finx22openplatform.fintech-galaxy.com/obp/v3.1.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221

  • 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:

Typical Successful Response:

								
									
{ "resource_docs":[{ "operation_id":"OBPv1.4.0-testResourceDoc", "implemented_by":{ "version":"OBPv1.4.0", "function":"testResourceDoc" }, "request_verb":"GET", "request_url":"/dummy", "summary":"Test Resource Doc", "description":"<p>I am only a test Resource Doc</p>\n<p>Authentication is Optional</p>\n<p><strong>JSON response body fields:</strong></p>\n", "description_markdown":"I am only a test Resource Doc\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n", "example_request_body":{ "jsonString":"{}" }, "success_response_body":{ "jsonString":"{}" }, "error_response_bodies":["OBP-50000: Unknown Error."], "tags":["Documentation"], "typed_request_body":{ "type":"object", "properties":{ "jsonString":{ "type":"string" } } }, "typed_success_response_body":{ "type":"object", "properties":{ "jsonString":{ "type":"string" } } }, "is_featured":false, "special_instructions":"", "specified_url":"", "connector_methods":[] }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by getResourceDocsObp, operation_id: OBPv1.4.0-getResourceDocsObp Tags: Documentation, API,

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://finx22openplatform.fintech-galaxy.com/obp/v3.1.0/resource-docs/v3.1.0/swagger
https://finx22openplatform.fintech-galaxy.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
https://finx22openplatform.fintech-galaxy.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
https://finx22openplatform.fintech-galaxy.com/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:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by getResourceDocsSwagger, operation_id: OBPv1.4.0-getResourceDocsSwagger Tags: Documentation, API,

Get scanned API Versions

Get all the scanned API Versions.

Authentication is Optional

JSON response body fields:

Typical Successful Response:

								
									
{ "scanned_api_versions":[{ "urlPrefix":"obp", "apiStandard":"obp", "apiShortVersion":"v3.1.0", "API_VERSION":"v3.1.0" }] }
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 getScannedApiVersions, operation_id: OBPv4.0.0-getScannedApiVersions Tags: Documentation, API,

Delete Bank Level Dynamic Endpoint

Delete a Bank Level DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteBankLevelDynamicEndpoint - Please login to request this Role
  • CanDeleteDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteBankLevelDynamicEndpoint, operation_id: OBPv4.0.0-deleteBankLevelDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API, New-Style,

Delete Dynamic Endpoint

Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteDynamicEndpoint - 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-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteDynamicEndpoint, operation_id: OBPv4.0.0-deleteDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API, New-Style,

Get Bank Level Dynamic Endpoint

Get a Bank Level Dynamic Endpoint.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "title":"Bank Accounts (Dynamic Endpoint)", "version":"1.0.0" }, "definitions":{ "AccountName":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"family account" }, "balance":{ "type":"integer", "format":"int64", "example":1000.123 } } } }, "paths":{ "/accounts":{ "post":{ "operationId":"POST_account", "produces":["application/json"], "responses":{ "201":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"POST Accounts", "summary":"POST Accounts" } }, "/accounts/{account_id}":{ "get":{ "operationId":"GET_account", "produces":["application/json"], "responses":{ "200":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"Get Bank Account", "summary":"Get Bank Account by Id" } } }, "host":"obp_mock", "schemes":["http","https"] } }
Required Roles:
  • CanGetBankLevelDynamicEndpoint - Please login to request this Role
  • CanGetDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getBankLevelDynamicEndpoint, operation_id: OBPv4.0.0-getBankLevelDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API, New-Style,

Get Dynamic Endpoints

Get Dynamic Endpoints.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_endpoints":[{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "title":"Bank Accounts (Dynamic Endpoint)", "version":"1.0.0" }, "definitions":{ "AccountName":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"family account" }, "balance":{ "type":"integer", "format":"int64", "example":1000.123 } } } }, "paths":{ "/accounts":{ "post":{ "operationId":"POST_account", "produces":["application/json"], "responses":{ "201":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"POST Accounts", "summary":"POST Accounts" } }, "/accounts/{account_id}":{ "get":{ "operationId":"GET_account", "produces":["application/json"], "responses":{ "200":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"Get Bank Account", "summary":"Get Bank Account by Id" } } }, "host":"obp_mock", "schemes":["http","https"] } }] }
Required Roles:
  • CanGetDynamicEndpoints - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getDynamicEndpoints, operation_id: OBPv4.0.0-getDynamicEndpoints Tags: Dynamic-Endpoint-Manage, API, New-Style,

Update Bank Level Dynamic Endpoint Host

Update Bank Level dynamic endpoint Host.
The value can be obp_mock, dynamic_entity, or some service url.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "host":"dynamic_entity" }
Required Roles:
  • CanUpdateBankLevelDynamicEndpoint - Please login to request this Role
  • CanUpdateDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-09001: DynamicEntity not found. Please specify a valid value for DYNAMIC_ENTITY_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateBankLevelDynamicEndpointHost, operation_id: OBPv4.0.0-updateBankLevelDynamicEndpointHost Tags: Dynamic-Endpoint-Manage, API, New-Style,

Update Dynamic Endpoint Host

Update dynamic endpoint Host.
The value can be obp_mock, dynamic_entity, or some service url.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "host":"dynamic_entity" }
Required Roles:
  • CanUpdateDynamicEndpoint - 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-09001: DynamicEntity not found. Please specify a valid value for DYNAMIC_ENTITY_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateDynamicEndpointHost, operation_id: OBPv4.0.0-updateDynamicEndpointHost Tags: Dynamic-Endpoint-Manage, API, New-Style,

Create Bank Level Dynamic Endpoint

Create dynamic endpoints.

Create dynamic endpoints with one json format swagger content.

If the host of swagger is dynamic_entity, then you need link the swagger fields to the dynamic entity fields,
please check Endpoint Mapping endpoints.

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

Typical Successful Response:

								
									
{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "title":"Bank Accounts (Dynamic Endpoint)", "version":"1.0.0" }, "definitions":{ "AccountName":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"family account" }, "balance":{ "type":"integer", "format":"int64", "example":1000.123 } } } }, "paths":{ "/accounts":{ "post":{ "operationId":"POST_account", "produces":["application/json"], "responses":{ "201":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"POST Accounts", "summary":"POST Accounts" } }, "/accounts/{account_id}":{ "get":{ "operationId":"GET_account", "produces":["application/json"], "responses":{ "200":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"Get Bank Account", "summary":"Get Bank Account by Id" } } }, "host":"obp_mock", "schemes":["http","https"] } }
Required Roles:
  • CanCreateBankLevelDynamicEndpoint - Please login to request this Role
  • CanCreateDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-09008: DynamicEndpoint already exists.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createBankLevelDynamicEndpoint, operation_id: OBPv4.0.0-createBankLevelDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API, New-Style,

Create Dynamic Endpoint

Create dynamic endpoints.

Create dynamic endpoints with one json format swagger content.

If the host of swagger is dynamic_entity, then you need link the swagger fields to the dynamic entity fields,
please check Endpoint Mapping endpoints.

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

Typical Successful Response:

								
									
{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "title":"Bank Accounts (Dynamic Endpoint)", "version":"1.0.0" }, "definitions":{ "AccountName":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"family account" }, "balance":{ "type":"integer", "format":"int64", "example":1000.123 } } } }, "paths":{ "/accounts":{ "post":{ "operationId":"POST_account", "produces":["application/json"], "responses":{ "201":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"POST Accounts", "summary":"POST Accounts" } }, "/accounts/{account_id}":{ "get":{ "operationId":"GET_account", "produces":["application/json"], "responses":{ "200":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"Get Bank Account", "summary":"Get Bank Account by Id" } } }, "host":"obp_mock", "schemes":["http","https"] } }
Required Roles:
  • CanCreateDynamicEndpoint - 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-09008: DynamicEndpoint already exists.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createDynamicEndpoint, operation_id: OBPv4.0.0-createDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API, New-Style,

Delete My Dynamic Endpoint

Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteMyDynamicEndpoint, operation_id: OBPv4.0.0-deleteMyDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API, New-Style,

Get Bank Level Dynamic Endpoints

Get Bank Level Dynamic Endpoints.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_endpoints":[{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "title":"Bank Accounts (Dynamic Endpoint)", "version":"1.0.0" }, "definitions":{ "AccountName":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"family account" }, "balance":{ "type":"integer", "format":"int64", "example":1000.123 } } } }, "paths":{ "/accounts":{ "post":{ "operationId":"POST_account", "produces":["application/json"], "responses":{ "201":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"POST Accounts", "summary":"POST Accounts" } }, "/accounts/{account_id}":{ "get":{ "operationId":"GET_account", "produces":["application/json"], "responses":{ "200":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"Get Bank Account", "summary":"Get Bank Account by Id" } } }, "host":"obp_mock", "schemes":["http","https"] } }] }
Required Roles:
  • CanGetBankLevelDynamicEndpoints - Please login to request this Role
  • CanGetDynamicEndpoints - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getBankLevelDynamicEndpoints, operation_id: OBPv4.0.0-getBankLevelDynamicEndpoints Tags: Dynamic-Endpoint-Manage, API, New-Style,

Get Dynamic Endpoint

Get a Dynamic Endpoint.

Get one DynamicEndpoint,

Authentication is Mandatory

Typical Successful Response:

								
									
{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "title":"Bank Accounts (Dynamic Endpoint)", "version":"1.0.0" }, "definitions":{ "AccountName":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"family account" }, "balance":{ "type":"integer", "format":"int64", "example":1000.123 } } } }, "paths":{ "/accounts":{ "post":{ "operationId":"POST_account", "produces":["application/json"], "responses":{ "201":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"POST Accounts", "summary":"POST Accounts" } }, "/accounts/{account_id}":{ "get":{ "operationId":"GET_account", "produces":["application/json"], "responses":{ "200":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"Get Bank Account", "summary":"Get Bank Account by Id" } } }, "host":"obp_mock", "schemes":["http","https"] } }
Required Roles:
  • CanGetDynamicEndpoint - 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-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getDynamicEndpoint, operation_id: OBPv4.0.0-getDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API, New-Style,

Get My Dynamic Endpoints

Get My Dynamic Endpoints.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_endpoints":[{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "title":"Bank Accounts (Dynamic Endpoint)", "version":"1.0.0" }, "definitions":{ "AccountName":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"family account" }, "balance":{ "type":"integer", "format":"int64", "example":1000.123 } } } }, "paths":{ "/accounts":{ "post":{ "operationId":"POST_account", "produces":["application/json"], "responses":{ "201":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"POST Accounts", "summary":"POST Accounts" } }, "/accounts/{account_id}":{ "get":{ "operationId":"GET_account", "produces":["application/json"], "responses":{ "200":{ "description":"Success Response", "schema":{ "$ref":"#/definitions/AccountName" } } }, "consumes":["application/json"], "description":"Get Bank Account", "summary":"Get Bank Account by Id" } } }, "host":"obp_mock", "schemes":["http","https"] } }] }
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 getMyDynamicEndpoints, operation_id: OBPv4.0.0-getMyDynamicEndpoints Tags: Dynamic-Endpoint-Manage, API, New-Style,

Create Bank Level Dynamic Entity

Create a Bank Level DynamicEntity.

Authentication is Mandatory

Create one DynamicEntity, after created success, the corresponding CRUD endpoints will be generated automatically

Current support field types as follow:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:

"someField0": {
    "type": "reference:Cars",
    "example": "ba5001a1-6c41-42aa-8de1-a62463624f20"
}

"someField1": {
    "type": "reference:Bank",
    "example": "ba5001a1-6c41-42aa-8de1-a62463624f20"
}

"someField2": {
    "type": "reference:Consumer",
    "example": "ba5001a1-6c41-42aa-8de1-a62463624f20"
}

"someField3": {
    "type": "reference:Customer",
    "example": "ba5001a1-6c41-42aa-8de1-a62463624f20"
}

"someField4": {
    "type": "reference:MethodRouting",
    "example": "ba5001a1-6c41-42aa-8de1-a62463624f20"
}

"someField5": {
    "type": "reference:DynamicEntity",
    "example": "ba5001a1-6c41-42aa-8de1-a62463624f20"
}

"someField6": {
    "type": "reference:TransactionRequest",
    "example": "ba5001a1-6c41-42aa-8de1-a62463624f20"
}

"someField7": {
    "type": "reference:ProductAttribute",
    "example": "ba5001a1-6c41-42aa-8de1-a62463624f20"
}

"someField8": {
    "type": "reference:AccountAttribute",
    "example": "ba5001a1-6c41-42aa-8de1-a62463624f20"
}

"someField9": {
    "type": "reference:TransactionAttribute",
    "example": "ba5001a1-6c41-42aa-8de1-a62463624f20"
}

"someField10": {
    "type": "reference:CustomerAttribute",
    "example": "ba5001a1-6c41-42aa-8de1-a62463624f20"
}

"someField11": {
    "type": "reference:AccountApplication",
    "example": "ba5001a1-6c41-42aa-8de1-a62463624f20"
}

"someField12": {
    "type": "reference:CardAttribute",
    "example": "ba5001a1-6c41-42aa-8de1-a62463624f20"
}

"someField13": {
    "type": "reference:Counterparty",
    "example": "ba5001a1-6c41-42aa-8de1-a62463624f20"
}

"someField14": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=ba5001a1-6c41-42aa-8de1-a62463624f20&branchId=6d3c471d-fe8a-4cc0-b773-1dacba7ba493"
}

"someField15": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=ba5001a1-6c41-42aa-8de1-a62463624f20&atmId=6d3c471d-fe8a-4cc0-b773-1dacba7ba493"
}

"someField16": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=ba5001a1-6c41-42aa-8de1-a62463624f20&accountId=6d3c471d-fe8a-4cc0-b773-1dacba7ba493"
}

"someField17": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=ba5001a1-6c41-42aa-8de1-a62463624f20&productCode=6d3c471d-fe8a-4cc0-b773-1dacba7ba493"
}

"someField18": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=ba5001a1-6c41-42aa-8de1-a62463624f20&cardId=6d3c471d-fe8a-4cc0-b773-1dacba7ba493"
}

"someField19": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=ba5001a1-6c41-42aa-8de1-a62463624f20&accountId=6d3c471d-fe8a-4cc0-b773-1dacba7ba493&transactionId=b162c3be-81ae-4d27-a0a5-e52a75f37358"
}

"someField20": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=ba5001a1-6c41-42aa-8de1-a62463624f20&accountId=6d3c471d-fe8a-4cc0-b773-1dacba7ba493&counterpartyId=b162c3be-81ae-4d27-a0a5-e52a75f37358"
}

Note: BankId filed is optional,
if you add it, the entity will be the Bank level.
if you omit it, the entity will be the System level.

Typical Successful Response:

								
									
{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }
Required Roles:
  • CanCreateBankLevelDynamicEntity - Please login to request this Role
  • CanCreateDynamicEntity - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createBankLevelDynamicEntity, operation_id: OBPv4.0.0-createBankLevelDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Create Dynamic Entity

Create a DynamicEntity.

Authentication is Mandatory

Create one DynamicEntity, after created success, the corresponding CRUD endpoints will be generated automatically

Current support field types as follow:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:

"someField0": {
    "type": "reference:Cars",
    "example": "6b507919-066f-466d-a7e6-7be0f3a7b7ce"
}

"someField1": {
    "type": "reference:Bank",
    "example": "6b507919-066f-466d-a7e6-7be0f3a7b7ce"
}

"someField2": {
    "type": "reference:Consumer",
    "example": "6b507919-066f-466d-a7e6-7be0f3a7b7ce"
}

"someField3": {
    "type": "reference:Customer",
    "example": "6b507919-066f-466d-a7e6-7be0f3a7b7ce"
}

"someField4": {
    "type": "reference:MethodRouting",
    "example": "6b507919-066f-466d-a7e6-7be0f3a7b7ce"
}

"someField5": {
    "type": "reference:DynamicEntity",
    "example": "6b507919-066f-466d-a7e6-7be0f3a7b7ce"
}

"someField6": {
    "type": "reference:TransactionRequest",
    "example": "6b507919-066f-466d-a7e6-7be0f3a7b7ce"
}

"someField7": {
    "type": "reference:ProductAttribute",
    "example": "6b507919-066f-466d-a7e6-7be0f3a7b7ce"
}

"someField8": {
    "type": "reference:AccountAttribute",
    "example": "6b507919-066f-466d-a7e6-7be0f3a7b7ce"
}

"someField9": {
    "type": "reference:TransactionAttribute",
    "example": "6b507919-066f-466d-a7e6-7be0f3a7b7ce"
}

"someField10": {
    "type": "reference:CustomerAttribute",
    "example": "6b507919-066f-466d-a7e6-7be0f3a7b7ce"
}

"someField11": {
    "type": "reference:AccountApplication",
    "example": "6b507919-066f-466d-a7e6-7be0f3a7b7ce"
}

"someField12": {
    "type": "reference:CardAttribute",
    "example": "6b507919-066f-466d-a7e6-7be0f3a7b7ce"
}

"someField13": {
    "type": "reference:Counterparty",
    "example": "6b507919-066f-466d-a7e6-7be0f3a7b7ce"
}

"someField14": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=6b507919-066f-466d-a7e6-7be0f3a7b7ce&branchId=79b462f1-ead5-4c3c-8da3-962cd70e1f77"
}

"someField15": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=6b507919-066f-466d-a7e6-7be0f3a7b7ce&atmId=79b462f1-ead5-4c3c-8da3-962cd70e1f77"
}

"someField16": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=6b507919-066f-466d-a7e6-7be0f3a7b7ce&accountId=79b462f1-ead5-4c3c-8da3-962cd70e1f77"
}

"someField17": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=6b507919-066f-466d-a7e6-7be0f3a7b7ce&productCode=79b462f1-ead5-4c3c-8da3-962cd70e1f77"
}

"someField18": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=6b507919-066f-466d-a7e6-7be0f3a7b7ce&cardId=79b462f1-ead5-4c3c-8da3-962cd70e1f77"
}

"someField19": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=6b507919-066f-466d-a7e6-7be0f3a7b7ce&accountId=79b462f1-ead5-4c3c-8da3-962cd70e1f77&transactionId=68f50c91-8e5d-4d5b-a600-f65ea0338b61"
}

"someField20": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=6b507919-066f-466d-a7e6-7be0f3a7b7ce&accountId=79b462f1-ead5-4c3c-8da3-962cd70e1f77&counterpartyId=68f50c91-8e5d-4d5b-a600-f65ea0338b61"
}

Note: BankId filed is optional,
if you add it, the entity will be the Bank level.
if you omit it, the entity will be the System level.

Typical Successful Response:

								
									
{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }
Required Roles:
  • CanCreateDynamicEntity - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createDynamicEntity, operation_id: OBPv4.0.0-createDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Delete Bank Level Dynamic Entity

Delete a Bank Level DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteBankLevelDynamicEntity - Please login to request this Role
  • CanDeleteDynamicEntity - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • 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: OBPv4.0.0, function_name: by deleteBankLevelDynamicEntity, operation_id: OBPv4.0.0-deleteBankLevelDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Delete Dynamic Entity

Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteDynamicEntity - 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: OBPv4.0.0, function_name: by deleteDynamicEntity, operation_id: OBPv4.0.0-deleteDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Delete My Dynamic Entity

Delete my DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
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 deleteMyDynamicEntity, operation_id: OBPv4.0.0-deleteMyDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Get Bank Level Dynamic Entities

Get all the bank level Dynamic Entities for one bank.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_entities":[{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }] }
Required Roles:
  • CanGetBankLevelDynamicEntities - Please login to request this Role
  • CanGetDynamicEntities - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • 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: OBPv4.0.0, function_name: by getBankLevelDynamicEntities, operation_id: OBPv4.0.0-getBankLevelDynamicEntities Tags: Dynamic-Entity-Manage, API, New-Style,

Get Dynamic Entities

Get the all Dynamic Entities.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_entities":[{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }] }
Required Roles:
  • CanGetDynamicEntities - 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: OBPv4.0.0, function_name: by getDynamicEntities, operation_id: OBPv4.0.0-getDynamicEntities Tags: Dynamic-Entity-Manage, API, New-Style,

Get My Dynamic Entities

Get all my Dynamic Entities.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_entities":[{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }] }
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 getMyDynamicEntities, operation_id: OBPv4.0.0-getMyDynamicEntities Tags: Dynamic-Entity-Manage, API, New-Style,

Update Bank Level Dynamic Entity

Update a Bank Level DynamicEntity.

Authentication is Mandatory

Update one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.

Current support field types as follow:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:

"someField0": {
    "type": "reference:Cars",
    "example": "e8c53785-1cf6-4394-b0cb-69281ff09de6"
}

"someField1": {
    "type": "reference:Bank",
    "example": "e8c53785-1cf6-4394-b0cb-69281ff09de6"
}

"someField2": {
    "type": "reference:Consumer",
    "example": "e8c53785-1cf6-4394-b0cb-69281ff09de6"
}

"someField3": {
    "type": "reference:Customer",
    "example": "e8c53785-1cf6-4394-b0cb-69281ff09de6"
}

"someField4": {
    "type": "reference:MethodRouting",
    "example": "e8c53785-1cf6-4394-b0cb-69281ff09de6"
}

"someField5": {
    "type": "reference:DynamicEntity",
    "example": "e8c53785-1cf6-4394-b0cb-69281ff09de6"
}

"someField6": {
    "type": "reference:TransactionRequest",
    "example": "e8c53785-1cf6-4394-b0cb-69281ff09de6"
}

"someField7": {
    "type": "reference:ProductAttribute",
    "example": "e8c53785-1cf6-4394-b0cb-69281ff09de6"
}

"someField8": {
    "type": "reference:AccountAttribute",
    "example": "e8c53785-1cf6-4394-b0cb-69281ff09de6"
}

"someField9": {
    "type": "reference:TransactionAttribute",
    "example": "e8c53785-1cf6-4394-b0cb-69281ff09de6"
}

"someField10": {
    "type": "reference:CustomerAttribute",
    "example": "e8c53785-1cf6-4394-b0cb-69281ff09de6"
}

"someField11": {
    "type": "reference:AccountApplication",
    "example": "e8c53785-1cf6-4394-b0cb-69281ff09de6"
}

"someField12": {
    "type": "reference:CardAttribute",
    "example": "e8c53785-1cf6-4394-b0cb-69281ff09de6"
}

"someField13": {
    "type": "reference:Counterparty",
    "example": "e8c53785-1cf6-4394-b0cb-69281ff09de6"
}

"someField14": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=e8c53785-1cf6-4394-b0cb-69281ff09de6&branchId=508dba6a-1a56-4b4d-a89a-04be16fc963b"
}

"someField15": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=e8c53785-1cf6-4394-b0cb-69281ff09de6&atmId=508dba6a-1a56-4b4d-a89a-04be16fc963b"
}

"someField16": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=e8c53785-1cf6-4394-b0cb-69281ff09de6&accountId=508dba6a-1a56-4b4d-a89a-04be16fc963b"
}

"someField17": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=e8c53785-1cf6-4394-b0cb-69281ff09de6&productCode=508dba6a-1a56-4b4d-a89a-04be16fc963b"
}

"someField18": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=e8c53785-1cf6-4394-b0cb-69281ff09de6&cardId=508dba6a-1a56-4b4d-a89a-04be16fc963b"
}

"someField19": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=e8c53785-1cf6-4394-b0cb-69281ff09de6&accountId=508dba6a-1a56-4b4d-a89a-04be16fc963b&transactionId=99070b12-ec1c-4b45-a44e-2ae7984460f4"
}

"someField20": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=e8c53785-1cf6-4394-b0cb-69281ff09de6&accountId=508dba6a-1a56-4b4d-a89a-04be16fc963b&counterpartyId=99070b12-ec1c-4b45-a44e-2ae7984460f4"
}

Typical Successful Response:

								
									
{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }
Required Roles:
  • CanUpdateBankLevelDynamicEntity - Please login to request this Role
  • CanUpdateDynamicEntity - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateBankLevelDynamicEntity, operation_id: OBPv4.0.0-updateBankLevelDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Update Dynamic Entity

Update a DynamicEntity.

Authentication is Mandatory

Update one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.

Current support field types as follow:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:

"someField0": {
    "type": "reference:Cars",
    "example": "9edaa7a8-d869-4a66-8686-85a05a7930c8"
}

"someField1": {
    "type": "reference:Bank",
    "example": "9edaa7a8-d869-4a66-8686-85a05a7930c8"
}

"someField2": {
    "type": "reference:Consumer",
    "example": "9edaa7a8-d869-4a66-8686-85a05a7930c8"
}

"someField3": {
    "type": "reference:Customer",
    "example": "9edaa7a8-d869-4a66-8686-85a05a7930c8"
}

"someField4": {
    "type": "reference:MethodRouting",
    "example": "9edaa7a8-d869-4a66-8686-85a05a7930c8"
}

"someField5": {
    "type": "reference:DynamicEntity",
    "example": "9edaa7a8-d869-4a66-8686-85a05a7930c8"
}

"someField6": {
    "type": "reference:TransactionRequest",
    "example": "9edaa7a8-d869-4a66-8686-85a05a7930c8"
}

"someField7": {
    "type": "reference:ProductAttribute",
    "example": "9edaa7a8-d869-4a66-8686-85a05a7930c8"
}

"someField8": {
    "type": "reference:AccountAttribute",
    "example": "9edaa7a8-d869-4a66-8686-85a05a7930c8"
}

"someField9": {
    "type": "reference:TransactionAttribute",
    "example": "9edaa7a8-d869-4a66-8686-85a05a7930c8"
}

"someField10": {
    "type": "reference:CustomerAttribute",
    "example": "9edaa7a8-d869-4a66-8686-85a05a7930c8"
}

"someField11": {
    "type": "reference:AccountApplication",
    "example": "9edaa7a8-d869-4a66-8686-85a05a7930c8"
}

"someField12": {
    "type": "reference:CardAttribute",
    "example": "9edaa7a8-d869-4a66-8686-85a05a7930c8"
}

"someField13": {
    "type": "reference:Counterparty",
    "example": "9edaa7a8-d869-4a66-8686-85a05a7930c8"
}

"someField14": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=9edaa7a8-d869-4a66-8686-85a05a7930c8&branchId=d67512d8-282d-4359-88a2-cd3b0dc6df70"
}

"someField15": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=9edaa7a8-d869-4a66-8686-85a05a7930c8&atmId=d67512d8-282d-4359-88a2-cd3b0dc6df70"
}

"someField16": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=9edaa7a8-d869-4a66-8686-85a05a7930c8&accountId=d67512d8-282d-4359-88a2-cd3b0dc6df70"
}

"someField17": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=9edaa7a8-d869-4a66-8686-85a05a7930c8&productCode=d67512d8-282d-4359-88a2-cd3b0dc6df70"
}

"someField18": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=9edaa7a8-d869-4a66-8686-85a05a7930c8&cardId=d67512d8-282d-4359-88a2-cd3b0dc6df70"
}

"someField19": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=9edaa7a8-d869-4a66-8686-85a05a7930c8&accountId=d67512d8-282d-4359-88a2-cd3b0dc6df70&transactionId=9deb6df2-c5d6-4697-8cbe-ff148ad82e3e"
}

"someField20": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=9edaa7a8-d869-4a66-8686-85a05a7930c8&accountId=d67512d8-282d-4359-88a2-cd3b0dc6df70&counterpartyId=9deb6df2-c5d6-4697-8cbe-ff148ad82e3e"
}

Typical Successful Response:

								
									
{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }
Required Roles:
  • CanUpdateDynamicEntity - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateDynamicEntity, operation_id: OBPv4.0.0-updateDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Update My Dynamic Entity

Update my DynamicEntity.

Authentication is Mandatory

Update one of my DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.

Current support filed types as follow:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:

"someField0": {
    "type": "reference:Cars",
    "example": "8a7f928b-6388-4f50-a09b-c8f308059e42"
}

"someField1": {
    "type": "reference:Bank",
    "example": "8a7f928b-6388-4f50-a09b-c8f308059e42"
}

"someField2": {
    "type": "reference:Consumer",
    "example": "8a7f928b-6388-4f50-a09b-c8f308059e42"
}

"someField3": {
    "type": "reference:Customer",
    "example": "8a7f928b-6388-4f50-a09b-c8f308059e42"
}

"someField4": {
    "type": "reference:MethodRouting",
    "example": "8a7f928b-6388-4f50-a09b-c8f308059e42"
}

"someField5": {
    "type": "reference:DynamicEntity",
    "example": "8a7f928b-6388-4f50-a09b-c8f308059e42"
}

"someField6": {
    "type": "reference:TransactionRequest",
    "example": "8a7f928b-6388-4f50-a09b-c8f308059e42"
}

"someField7": {
    "type": "reference:ProductAttribute",
    "example": "8a7f928b-6388-4f50-a09b-c8f308059e42"
}

"someField8": {
    "type": "reference:AccountAttribute",
    "example": "8a7f928b-6388-4f50-a09b-c8f308059e42"
}

"someField9": {
    "type": "reference:TransactionAttribute",
    "example": "8a7f928b-6388-4f50-a09b-c8f308059e42"
}

"someField10": {
    "type": "reference:CustomerAttribute",
    "example": "8a7f928b-6388-4f50-a09b-c8f308059e42"
}

"someField11": {
    "type": "reference:AccountApplication",
    "example": "8a7f928b-6388-4f50-a09b-c8f308059e42"
}

"someField12": {
    "type": "reference:CardAttribute",
    "example": "8a7f928b-6388-4f50-a09b-c8f308059e42"
}

"someField13": {
    "type": "reference:Counterparty",
    "example": "8a7f928b-6388-4f50-a09b-c8f308059e42"
}

"someField14": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=8a7f928b-6388-4f50-a09b-c8f308059e42&branchId=8a8ba6fc-2350-4b7f-8209-f92991e4db57"
}

"someField15": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=8a7f928b-6388-4f50-a09b-c8f308059e42&atmId=8a8ba6fc-2350-4b7f-8209-f92991e4db57"
}

"someField16": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=8a7f928b-6388-4f50-a09b-c8f308059e42&accountId=8a8ba6fc-2350-4b7f-8209-f92991e4db57"
}

"someField17": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=8a7f928b-6388-4f50-a09b-c8f308059e42&productCode=8a8ba6fc-2350-4b7f-8209-f92991e4db57"
}

"someField18": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=8a7f928b-6388-4f50-a09b-c8f308059e42&cardId=8a8ba6fc-2350-4b7f-8209-f92991e4db57"
}

"someField19": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=8a7f928b-6388-4f50-a09b-c8f308059e42&accountId=8a8ba6fc-2350-4b7f-8209-f92991e4db57&transactionId=3648a10b-948b-4ba6-af3e-69bbd27c5f0c"
}

"someField20": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=8a7f928b-6388-4f50-a09b-c8f308059e42&accountId=8a8ba6fc-2350-4b7f-8209-f92991e4db57&counterpartyId=3648a10b-948b-4ba6-af3e-69bbd27c5f0c"
}

Typical Successful Response:

								
									
{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }
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 updateMyDynamicEntity, operation_id: OBPv4.0.0-updateMyDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Create Dynamic Message Doc

Create a Dynamic Message Doc.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "outbound_avro_schema":"no-example-provided", "inbound_avro_schema":"no-example-provided", "adapter_implementation":"no-example-provided", "dynamic_message_doc_id":"no-example-provided", "description":"no-example-provided", "process":"obp.getBank", "outbound_topic":"no-example-provided", "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29", "message_format":"no-example-provided", "example_outbound_message":{ }, "inbound_topic":"no-example-provided", "example_inbound_message":{ } }
Required Roles:
  • CanCreateDynamicMessageDoc - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createDynamicMessageDoc, operation_id: OBPv4.0.0-createDynamicMessageDoc Tags: Dynamic-Message-Doc-Manage, New-Style,