API Explorer

v5.1.0 filtered by tags: API ... (97 APIs)

Anfitrión de la API: https://api3.openbankproject.com
Banco
Cuentas
Vistas
Contrapartes
Transacciones

Create Bank Level Endpoint Tag

Create Bank Level Endpoint Tag

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

OPERATION_ID: OBPv4.0.0-getBanks

JSON request body fields:

tag_name: BankAccountTag1

JSON response body fields:

bank_id: gh.29.uk

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

operation_id: OBPv4.0.0-getBanks

tag_name: BankAccountTag1

Respuesta Exitosa Típica:

								
									
{ "bank_id":"gh.29.uk", "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks", "tag_name":"BankAccountTag1" }
Roles Requeridos:
  • CanCreateBankLevelEndpointTag - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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,

Create System Level Endpoint Tag

Create System Level Endpoint Tag

Authentication is Mandatory

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON request body fields:

tag_name: BankAccountTag1

JSON response body fields:

bank_id: gh.29.uk

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

operation_id: OBPv4.0.0-getBanks

tag_name: BankAccountTag1

Respuesta Exitosa Típica:

								
									
{ "bank_id":"gh.29.uk", "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks", "tag_name":"BankAccountTag1" }
Roles Requeridos:
  • CanCreateSystemLevelEndpointTag - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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,

Delete Bank Level Endpoint Tag

Delete Bank Level Endpoint Tag.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

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

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

value: 5987953

Respuesta Exitosa Típica:

								
									
{ "value":true }
Roles Requeridos:
  • CanDeleteBankLevelEndpointTag - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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,

Delete System Level Endpoint Tag

Delete System Level Endpoint Tag.

Authentication is Mandatory

URL Parameters:

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

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

value: 5987953

Respuesta Exitosa Típica:

								
									
{ "value":true }
Roles Requeridos:
  • CanDeleteSystemLevelEndpointTag - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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,

Get API Configuration

Returns information about:

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

Authentication is Mandatory

JSON response body fields:

akka:

cache:

elastic_search:

function_name:

log_level:

metrics:

ports:

property:

require_scopes_for_all_roles:

require_scopes_for_listed_roles: true

scopes:

ttl_in_seconds:

value: 5987953

warehouse:

remote_data_secret_matched:

Respuesta Exitosa Típica:

								
									
{ "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"] } }
Roles Requeridos:
  • CanGetConfig - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.1.0, function_name: by config, operation_id: OBPv3.1.0-config Tags: API,

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:

connector: connector

email: felixsmith@example.com

energy_source:

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

hosted_at:

hosted_by:

hostname: hostname

local_identity_provider: local_identity_provider

organisation:

organisation_website:

phone:

resource_docs_requires_role: resource_docs_requires_role

version:

version_status:

Respuesta Exitosa Típica:

								
									
{ "version":"String", "version_status":"String", "git_commit":"String", "connector":"String", "hostname":"String", "local_identity_provider":"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/" }, "resource_docs_requires_role":false }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
  • no connector set
Métodos de conector::
Version: OBPv5.1.0, function_name: by root, operation_id: OBPv5.1.0-root Tags: API,

Get Adapter Info

Get basic information about the Adapter.

Authentication is Optional

Authentication is Mandatory

JSON response body fields:

backend_messages: backend_messages

date: 2020-01-27

errorCode: errorCode

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

name: ACCOUNT_MANAGEMENT_FEE

source:

status:

text:

total_duration: total_duration

version:

duration: 5.123

Respuesta Exitosa Típica:

								
									
{ "name":"ACCOUNT_MANAGEMENT_FEE", "version":"", "git_commit":"59623811dd8a41f6ffe67be46954eee11913dc28", "date":"2020-01-27", "total_duration":"5.123", "backend_messages":[{ "source":"", "status":"", "errorCode":"", "text":"", "duration":"5.123" }] }
Roles Requeridos:
  • CanGetAdapterInfo - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv5.0.0, function_name: by getAdapterInfo, operation_id: OBPv5.0.0-getAdapterInfo Tags: API,

Get Adapter Info for a bank

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

Authentication is Optional

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

date: 2020-01-27

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

name: ACCOUNT_MANAGEMENT_FEE

version:

Respuesta Exitosa Típica:

								
									
{ "name":"String", "version":"String", "git_commit":"String", "date":"2013-01-21T23:08:00Z" }
Roles Requeridos:
  • CanGetAdapterInfoAtOneBank - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Version: OBPv3.0.0, function_name: by getAdapterInfoForBank, operation_id: OBPv3.0.0-getAdapterInfoForBank Tags: API,

Get Bank Level Endpoint Tags

Get Bank Level Endpoint Tags.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

bank_id: gh.29.uk

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

operation_id: OBPv4.0.0-getBanks

tag_name: BankAccountTag1

Respuesta Exitosa Típica:

								
									
[{ "bank_id":"gh.29.uk", "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks", "tag_name":"BankAccountTag1" }]
Roles Requeridos:
  • CanGetBankLevelEndpointTag - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getBankLevelEndpointTags, operation_id: OBPv4.0.0-getBankLevelEndpointTags Tags: API,

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:

connector_version:

duration_time: 60

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

Respuesta Exitosa Típica:

								
									
{ "connector_version":"kafka_vSept2018", "git_commit":"f0acd4be14cdcb94be3433ec95c1ad65228812a0", "duration_time":"10 ms" }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Métodos de conector::
Version: OBPv3.1.0, function_name: by getObpConnectorLoopback, operation_id: OBPv3.1.0-getObpConnectorLoopback Tags: API,

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:

e:

kid:

kty:

n:

use:

Respuesta Exitosa Típica:

								
									
{ "kty":"RSA", "e":"AQAB", "use":"sig", "kid":"fr6-BxXH5gikFeZ2O6rGk0LUmJpukeswASN_TMW8U_s", "n":"hrB0OWqg6AeNU3WCnhheG18R5EbQtdNYGOaSeylTjkj2lZr0_vkhNVYvase-CroxO4HOT06InxTYwLnmJiyv2cZxReuoVjTlk--olGu-9MZooiFiqWez0JzndyKxQ27OiAjFsMh0P04kaUXeHKhXRfiU7K2FqBshR1UlnWe7iHLkq2p9rrGjxQc7ff0w-Uc0f-8PWg36Y2Od7s65493iVQwnI13egqMaSvgB1s8_dgm08noEjhr8C5m1aKmr5oipWEPNi-SBV2VNuiCLR1IEPuXq0tOwwZfv31t34KPO-2H2bbaWmzGJy9mMOGqoNrbXyGiUZoyeHRELaNtm1GilyQ" }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.1.0, function_name: by getServerJWK, operation_id: OBPv3.1.0-getServerJWK Tags: API, Account Information Service (AIS), PSD2,

Get JSON Web Key (JWK) URIs

Get the OAuth2 server's public JSON Web Key (JWK) URIs.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.

Authentication is Optional

JSON response body fields:

jwks_uri:

jwks_uris:

Respuesta Exitosa Típica:

								
									
{ "jwks_uris":[{ "jwks_uri":"https://www.googleapis.com/oauth2/v3/certs" }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.1.0, function_name: by getOAuth2ServerJWKsURIs, operation_id: OBPv3.1.0-getOAuth2ServerJWKsURIs Tags: API,

Get Mapper Database Info

Get basic information about the Mapper Database.

Authentication is Mandatory

JSON response body fields:

date: 2020-01-27

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

name: ACCOUNT_MANAGEMENT_FEE

version:

Respuesta Exitosa Típica:

								
									
{ "name":"String", "version":"String", "git_commit":"String", "date":"2013-01-21T23:08:00Z" }
Roles Requeridos:
  • CanGetDatabaseInfo - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv4.0.0, function_name: by getMapperDatabaseInfo, operation_id: OBPv4.0.0-getMapperDatabaseInfo Tags: API,

Get Rate Limiting Info

Get information about the Rate Limiting setup on this OBP Instance such as:

Is rate limiting enabled and active?
What backend is used to keep track of the API calls (e.g. REDIS).

Authentication is Mandatory

JSON response body fields:

enabled: true

is_active: true

service_available:

technology: technology1

Respuesta Exitosa Típica:

								
									
{ "enabled":true, "technology":"REDIS", "service_available":true, "is_active":true }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Métodos de conector::
Version: OBPv3.1.0, function_name: by getRateLimitingInfo, operation_id: OBPv3.1.0-getRateLimitingInfo Tags: API,

Get System Level Endpoint Tags

Get System Level Endpoint Tags.

Authentication is Mandatory

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

bank_id: gh.29.uk

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

operation_id: OBPv4.0.0-getBanks

tag_name: BankAccountTag1

Respuesta Exitosa Típica:

								
									
[{ "bank_id":"gh.29.uk", "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks", "tag_name":"BankAccountTag1" }]
Roles Requeridos:
  • CanGetSystemLevelEndpointTag - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getSystemLevelEndpointTags, operation_id: OBPv4.0.0-getSystemLevelEndpointTags Tags: API,

Get the Call Context of a current call

Get the Call Context of the current call.

Authentication is Mandatory

JSON response body fields:

Respuesta Exitosa Típica:

								
									
Roles Requeridos:
  • CanGetCallContext - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv4.0.0, function_name: by getCallContext, operation_id: OBPv4.0.0-getCallContext Tags: API,

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:

BANK_ID: gh.29.uk

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

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

bank_id: gh.29.uk

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

operation_id: OBPv4.0.0-getBanks

tag_name: BankAccountTag1

Respuesta Exitosa Típica:

								
									
{ "bank_id":"gh.29.uk", "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks", "tag_name":"BankAccountTag1" }
Roles Requeridos:
  • CanUpdateBankLevelEndpointTag - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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,

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:

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

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

bank_id: gh.29.uk

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

operation_id: OBPv4.0.0-getBanks

tag_name: BankAccountTag1

Respuesta Exitosa Típica:

								
									
{ "bank_id":"gh.29.uk", "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks", "tag_name":"BankAccountTag1" }
Roles Requeridos:
  • CanUpdateSystemLevelEndpointTag - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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,

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:

Respuesta Exitosa Típica:

								
									
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by verifyRequestSignResponse, operation_id: OBPv4.0.0-verifyRequestSignResponse Tags: API,

Waiting For Godot

Waiting For Godot

Uses query parameter "sleep" in milliseconds.
For instance: .../waiting-for-godot?sleep=50 means postpone response in 50 milliseconds.

Authentication is Optional

JSON response body fields:

sleep_in_milliseconds: sleep_in_milliseconds

Respuesta Exitosa Típica:

								
									
{ "sleep_in_milliseconds":50 }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
  • no connector set
Métodos de conector::
Version: OBPv5.1.0, function_name: by waitingForGodot, operation_id: OBPv5.1.0-waitingForGodot Tags: API,

Create My Api Collection

Create Api Collection for logged in user.

Authentication is Mandatory

JSON request body fields:

api_collection_name: Favourites

is_sharable: is_sharable

description: This an optional field. Maximum length is 2000. It can be any characters here.

JSON response body fields:

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

api_collection_name: Favourites

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Respuesta Exitosa Típica:

								
									
{ "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "api_collection_name":"Favourites", "is_sharable":true, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by createMyApiCollection, operation_id: OBPv4.0.0-createMyApiCollection Tags: Api-Collection,

Create My Api Collection Endpoint

Create Api Collection Endpoint.

Authentication is Mandatory

URL Parameters:

API_COLLECTION_NAME: Favourites

JSON request body fields:

operation_id: OBPv4.0.0-getBanks

JSON response body fields:

api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

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

operation_id: OBPv4.0.0-getBanks

Respuesta Exitosa Típica:

								
									
{ "api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks" }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by createMyApiCollectionEndpoint, operation_id: OBPv4.0.0-createMyApiCollectionEndpoint Tags: Api-Collection,

Create My Api Collection Endpoint By Id

Create Api Collection Endpoint By Id.

Authentication is Mandatory

URL Parameters:

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

JSON request body fields:

operation_id: OBPv4.0.0-getBanks

JSON response body fields:

api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

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

operation_id: OBPv4.0.0-getBanks

Respuesta Exitosa Típica:

								
									
{ "api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks" }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by createMyApiCollectionEndpointById, operation_id: OBPv4.0.0-createMyApiCollectionEndpointById Tags: Api-Collection,

Delete My Api Collection

Delete Api Collection By API_COLLECTION_ID

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

value: 5987953

Respuesta Exitosa Típica:

								
									
{ "value":true }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by deleteMyApiCollection, operation_id: OBPv4.0.0-deleteMyApiCollection Tags: Api-Collection,

Delete My Api Collection Endpoint

Delete Api Collection Endpoint By OPERATION_ID

Authentication is Mandatory

URL Parameters:

API_COLLECTION_NAME: Favourites

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

value: 5987953

Respuesta Exitosa Típica:

								
									
{ "value":true }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by deleteMyApiCollectionEndpoint, operation_id: OBPv4.0.0-deleteMyApiCollectionEndpoint Tags: Api-Collection,

Delete My Api Collection Endpoint By Id

Delete Api Collection Endpoint
Delete Api Collection Endpoint By Id

Authentication is Mandatory

URL Parameters:

API_COLLECTION_ENDPOINT_ID: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

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

JSON response body fields:

value: 5987953

Respuesta Exitosa Típica:

								
									
{ "value":true }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by deleteMyApiCollectionEndpointById, operation_id: OBPv4.0.0-deleteMyApiCollectionEndpointById Tags: Api-Collection,

Delete My Api Collection Endpoint By Id

Delete Api Collection Endpoint By OPERATION_ID

Authentication is Mandatory

URL Parameters:

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

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

value: 5987953

Respuesta Exitosa Típica:

								
									
{ "value":true }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by deleteMyApiCollectionEndpointByOperationId, operation_id: OBPv4.0.0-deleteMyApiCollectionEndpointByOperationId Tags: Api-Collection,

Get All API Collections

Get All API Collections.

Authentication is Mandatory

JSON response body fields:

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

api_collection_name: Favourites

api_collections: api_collections

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Respuesta Exitosa Típica:

								
									
{ "api_collections":[{ "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "api_collection_name":"Favourites", "is_sharable":true, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }] }
Roles Requeridos:
  • CanGetAllApiCollections - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Métodos de conector::
Version: OBPv5.1.0, function_name: by getAllApiCollections, operation_id: OBPv5.1.0-getAllApiCollections Tags: Api-Collection,

Get Api Collection Endpoints

Get Api Collection Endpoints By API_COLLECTION_ID.

Authentication is Optional

URL Parameters:

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

JSON response body fields:

api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

api_collection_endpoints: api_collection_endpoints

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

operation_id: OBPv4.0.0-getBanks

Respuesta Exitosa Típica:

								
									
{ "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" }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getApiCollectionEndpoints, operation_id: OBPv4.0.0-getApiCollectionEndpoints Tags: Api-Collection,

Get Api Collections for User

Get Api Collections for User.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

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

api_collection_name: Favourites

api_collections: api_collections

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Respuesta Exitosa Típica:

								
									
{ "api_collections":[{ "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "api_collection_name":"Favourites", "is_sharable":true, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }] }
Roles Requeridos:
  • CanGetApiCollectionsForUser - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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:
Métodos de conector::
Version: OBPv4.0.0, function_name: by getApiCollectionsForUser, operation_id: OBPv4.0.0-getApiCollectionsForUser Tags: Api-Collection,

Get Featured Api Collections

Get Featured Api Collections.

Authentication is Optional

JSON response body fields:

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

api_collection_name: Favourites

api_collections: api_collections

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Respuesta Exitosa Típica:

								
									
{ "api_collections":[{ "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "api_collection_name":"Favourites", "is_sharable":true, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getFeaturedApiCollections, operation_id: OBPv4.0.0-getFeaturedApiCollections Tags: Api-Collection,

Get My Api Collection By Id

Get Api Collection By API_COLLECTION_ID.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

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

api_collection_name: Favourites

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Respuesta Exitosa Típica:

								
									
{ "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "api_collection_name":"Favourites", "is_sharable":true, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getMyApiCollectionById, operation_id: OBPv4.0.0-getMyApiCollectionById Tags: Api-Collection,

Get My Api Collection By Name

Get Api Collection By API_COLLECTION_NAME.

Authentication is Mandatory

URL Parameters:

API_COLLECTION_NAME: Favourites

JSON response body fields:

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

api_collection_name: Favourites

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Respuesta Exitosa Típica:

								
									
{ "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "api_collection_name":"Favourites", "is_sharable":true, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getMyApiCollectionByName, operation_id: OBPv4.0.0-getMyApiCollectionByName Tags: Api-Collection,

Get My Api Collection Endpoint

Get Api Collection Endpoint By API_COLLECTION_NAME and OPERATION_ID.

Authentication is Optional

URL Parameters:

API_COLLECTION_NAME: Favourites

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

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

operation_id: OBPv4.0.0-getBanks

Respuesta Exitosa Típica:

								
									
{ "api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "operation_id":"OBPv4.0.0-getBanks" }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getMyApiCollectionEndpoint, operation_id: OBPv4.0.0-getMyApiCollectionEndpoint Tags: Api-Collection,

Get My Api Collection Endpoints

Get Api Collection Endpoints By API_COLLECTION_NAME.

Authentication is Mandatory

URL Parameters:

API_COLLECTION_NAME: Favourites

JSON response body fields:

api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

api_collection_endpoints: api_collection_endpoints

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

operation_id: OBPv4.0.0-getBanks

Respuesta Exitosa Típica:

								
									
{ "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" }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getMyApiCollectionEndpoints, operation_id: OBPv4.0.0-getMyApiCollectionEndpoints Tags: Api-Collection,

Get My Api Collection Endpoints By Id

Get Api Collection Endpoints By API_COLLECTION_ID.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

api_collection_endpoints: api_collection_endpoints

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

operation_id: OBPv4.0.0-getBanks

Respuesta Exitosa Típica:

								
									
{ "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" }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20057: User not found by userId.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getMyApiCollectionEndpointsById, operation_id: OBPv4.0.0-getMyApiCollectionEndpointsById Tags: Api-Collection,

Get My Api Collections

Get all the apiCollections for logged in user.

Authentication is Mandatory

JSON response body fields:

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

api_collection_name: Favourites

api_collections: api_collections

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Respuesta Exitosa Típica:

								
									
{ "api_collections":[{ "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "api_collection_name":"Favourites", "is_sharable":true, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getMyApiCollections, operation_id: OBPv4.0.0-getMyApiCollections Tags: Api-Collection,

Get Sharable Api Collection By Id

Get Sharable Api Collection By Id.
Authentication is Optional

URL Parameters:

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

JSON response body fields:

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

api_collection_name: Favourites

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Respuesta Exitosa Típica:

								
									
{ "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "api_collection_name":"Favourites", "is_sharable":true, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getSharableApiCollectionById, operation_id: OBPv4.0.0-getSharableApiCollectionById Tags: Api-Collection,

Update My Api Collection By API_COLLECTION_ID

Update Api Collection for logged in user.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

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

api_collection_name: Favourites

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Respuesta Exitosa Típica:

								
									
{ "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "api_collection_name":"Favourites", "is_sharable":true, "description":"This an optional field. Maximum length is 2000. It can be any characters here." }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv5.1.0, function_name: by updateMyApiCollection, operation_id: OBPv5.1.0-updateMyApiCollection Tags: Api-Collection,

Create an Authentication Type Validation

Create an Authentication Type Validation.

Please supply allowed authentication types.

Authentication is Mandatory

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON request body fields:

JSON response body fields:

Respuesta Exitosa Típica:

								
									
{ "operation_id":"OBPv4.0.0-updateXxx", "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"] }
Roles Requeridos:
  • CanCreateAuthenticationTypeValidation - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by createAuthenticationTypeValidation, operation_id: OBPv4.0.0-createAuthenticationTypeValidation Tags: Authentication-Type-Validation,

Delete an Authentication Type Validation

Delete an Authentication Type Validation by operation_id.

Authentication is Mandatory

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

Respuesta Exitosa Típica:

								
									
true
Roles Requeridos:
  • CanDeleteAuthenticationValidation - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by deleteAuthenticationTypeValidation, operation_id: OBPv4.0.0-deleteAuthenticationTypeValidation Tags: Authentication-Type-Validation,

Get all Authentication Type Validations

Get all Authentication Type Validations.

Authentication is Mandatory

JSON response body fields:

Respuesta Exitosa Típica:

								
									
{ "authentication_types_validations":[{ "operation_id":"OBPv4.0.0-updateXxx", "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"] }] }
Roles Requeridos:
  • CanGetAuthenticationTypeValidation - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getAllAuthenticationTypeValidations, operation_id: OBPv4.0.0-getAllAuthenticationTypeValidations Tags: Authentication-Type-Validation,

Get all Authentication Type Validations - public

Get all Authentication Type Validations - public.

Authentication is Optional

JSON response body fields:

Respuesta Exitosa Típica:

								
									
{ "authentication_types_validations":[{ "operation_id":"OBPv4.0.0-updateXxx", "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"] }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getAllAuthenticationTypeValidationsPublic, operation_id: OBPv4.0.0-getAllAuthenticationTypeValidationsPublic Tags: Authentication-Type-Validation,

Get an Authentication Type Validation

Get an Authentication Type Validation by operation_id.

Authentication is Mandatory

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

Respuesta Exitosa Típica:

								
									
{ "operation_id":"OBPv4.0.0-updateXxx", "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"] }
Roles Requeridos:
  • CanGetAuthenticationTypeValidation - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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:
Métodos de conector::
Version: OBPv4.0.0, function_name: by getAuthenticationTypeValidation, operation_id: OBPv4.0.0-getAuthenticationTypeValidation Tags: Authentication-Type-Validation,

Update an Authentication Type Validation

Update an Authentication Type Validation.

Please supply allowed authentication types.

Authentication is Mandatory

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

Respuesta Exitosa Típica:

								
									
{ "operation_id":"OBPv4.0.0-updateXxx", "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"] }
Roles Requeridos:
  • CanUpdateAuthenticationTypeValidation - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by updateAuthenticationTypeValidation, operation_id: OBPv4.0.0-updateAuthenticationTypeValidation Tags: Authentication-Type-Validation,

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:

Respuesta Exitosa Típica:

								
									
{ "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", "programming_lang":"Scala" }
Roles Requeridos:
  • CanCreateConnectorMethod - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by createConnectorMethod, operation_id: OBPv4.0.0-createConnectorMethod Tags: Connector-Method,

Get Connector Method by Id

Get an internal connector by CONNECTOR_METHOD_ID.

Authentication is Mandatory

URL Parameters:

CONNECTOR_METHOD_ID: ace0352a-9a0f-4bfa-b30b-9003aa467f51

JSON response body fields:

Respuesta Exitosa Típica:

								
									
{ "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", "programming_lang":"Scala" }
Roles Requeridos:
  • CanGetConnectorMethod - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getConnectorMethod, operation_id: OBPv4.0.0-getConnectorMethod Tags: Connector-Method,

Get all Connector Methods

Get all Connector Methods.

Authentication is Mandatory

JSON response body fields:

Respuesta Exitosa Típica:

								
									
{ "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", "programming_lang":"Scala" }] }
Roles Requeridos:
  • CanGetAllConnectorMethods - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getAllConnectorMethods, operation_id: OBPv4.0.0-getAllConnectorMethods Tags: Connector-Method,

Update Connector Method

Update an internal connector.

The method_body is URL-encoded format String

Authentication is Mandatory

URL Parameters:

CONNECTOR_METHOD_ID: ace0352a-9a0f-4bfa-b30b-9003aa467f51

JSON response body fields:

Respuesta Exitosa Típica:

								
									
{ "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", "programming_lang":"Scala" }
Roles Requeridos:
  • CanUpdateConnectorMethod - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by updateConnectorMethod, operation_id: OBPv4.0.0-updateConnectorMethod Tags: Connector-Method,

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 i18n language tag , e.g. ?locale=zh_CN

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.

You can easily pass the cache, use different value for cache-modifier, eg: ?cache-modifier= 123

See the Resource Doc endpoint for more information.

Following are more examples:
https://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp
https://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?tags=Account,Bank
https://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?functions=getBanks,bankById
https://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=zh_CN
https://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
https://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?cache-modifier=3141592653

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

URL Parameters:

API_VERSION:

BANK_ID: gh.29.uk

JSON response body fields:

connector_methods: connector_methods

description: This an optional field. Maximum length is 2000. It can be any characters here.

description_markdown: description_markdown

error_response_bodies: OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.

example_request_body: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}

function: function

implemented_by: implemented_by

is_featured: false

operation_id: OBPv4.0.0-getBanks

request_url: /my_user/MY_USER_ID

request_verb: POST

resource_docs: resource_docs

special_instructions:

specified_url:

success_response_body: {"my_user_id": "some_id_value", "name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}

summary:

tags: Create-My-User

typed_request_body: typed_request_body

typed_success_response_body: typed_success_response_body

version:

created_by_bank_id: created_by_bank_id

meta:

roles: CanCreateMyUser

Respuesta Exitosa Típica:

								
									
{ "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 Mandatory</p>\n<p><strong>JSON response body fields:</strong></p>\n", "description_markdown":"I am only a test Resource Doc\n\nAuthentication is Mandatory\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.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "], "tags":["Documentation"], "typed_request_body":{ "type":"object", "properties":{ "jsonString":{ "type":"string" } } }, "typed_success_response_body":{ "type":"object", "properties":{ "jsonString":{ "type":"string" } } }, "roles":[{ "role":"CanGetCustomers", "requires_bank_id":true }], "is_featured":false, "special_instructions":"", "specified_url":"", "connector_methods":[] }] }
Roles Requeridos:
  • CanReadDynamicResourceDocsAtOneBank - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
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:

description: This an optional field. Maximum length is 2000. It can be any characters here.

glossary_items:

html: html format content

markdown:

title: Dr.

Respuesta Exitosa Típica:

								
									
{ "glossary_items":[{ "title":"Dr.", "description":{ "markdown":"String", "html":"String" } }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.0.0, function_name: by getApiGlossary, operation_id: OBPv3.0.0-getApiGlossary Tags: Documentation,

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_vSept2018, stored_procedure_vDec2019 ...

Authentication is Optional

URL Parameters:

CONNECTOR: CONNECTOR

JSON response body fields:

adapter_implementation:

dependent_endpoints:

description: This an optional field. Maximum length is 2000. It can be any characters here.

example_inbound_message: {}

example_outbound_message: {}

group:

message_docs:

message_format:

name: ACCOUNT_MANAGEMENT_FEE

process: obp.getBank

suggested_order:

version:

inboundAvroSchema:

inbound_topic:

outboundAvroSchema:

outbound_topic:

requiredFieldInfo: false

Respuesta Exitosa Típica:

								
									
{ "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"] } }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv2.2.0, function_name: by getMessageDocs, operation_id: OBPv2.2.0-getMessageDocs Tags: Documentation, API,

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:

CONNECTOR: CONNECTOR

JSON response body fields:

adapter_implementation:

dependent_endpoints:

description: This an optional field. Maximum length is 2000. It can be any characters here.

example_inbound_message: {}

example_outbound_message: {}

group:

message_docs:

message_format:

name: ACCOUNT_MANAGEMENT_FEE

process: obp.getBank

suggested_order:

version:

inboundAvroSchema:

inbound_topic:

outboundAvroSchema:

outbound_topic:

requiredFieldInfo: false

Respuesta Exitosa Típica:

								
									
{ "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"] } }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.1.0, function_name: by getMessageDocsSwagger, operation_id: OBPv3.1.0-getMessageDocsSwagger Tags: Documentation, API,

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 i18n language tag , e.g. ?locale=zh_CN

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.

You can easily pass the cache, use different value for cache-modifier, eg: ?cache-modifier= 123

See the Resource Doc endpoint for more information.

Following are more examples:
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=zh_CN
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?cache-modifier=3141592653

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

URL Parameters:

API_VERSION:

JSON response body fields:

connector_methods: connector_methods

count:

description: This an optional field. Maximum length is 2000. It can be any characters here.

description_markdown: description_markdown

error_response_bodies: OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.

example_request_body: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}

function: function

implemented_by: implemented_by

is_featured: false

operation_id: OBPv4.0.0-getBanks

request_url: /my_user/MY_USER_ID

request_verb: POST

resource_docs: resource_docs

response_date: response_date

special_instructions:

specified_url:

success_response_body: {"my_user_id": "some_id_value", "name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}

summary:

tags: Create-My-User

typed_request_body: typed_request_body

typed_success_response_body: typed_success_response_body

version:

created_by_bank_id: created_by_bank_id

meta:

roles: CanCreateMyUser

Respuesta Exitosa Típica:

								
									
{ "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 Mandatory</p>\n<p><strong>JSON response body fields:</strong></p>\n", "description_markdown":"I am only a test Resource Doc\n\nAuthentication is Mandatory\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.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "], "tags":["Documentation"], "typed_request_body":{ "type":"object", "properties":{ "jsonString":{ "type":"string" } } }, "typed_success_response_body":{ "type":"object", "properties":{ "jsonString":{ "type":"string" } } }, "roles":[{ "role":"CanGetCustomers", "requires_bank_id":true }], "is_featured":false, "special_instructions":"", "specified_url":"", "connector_methods":[] }], "meta":{ "response_date":"2024-10-06T00:00:38Z", "count":1 } }
Roles Requeridos:
  • CanReadResourceDoc - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv1.4.0, function_name: by getResourceDocsObpV400, operation_id: OBPv1.4.0-getResourceDocsObpV400 Tags: Documentation, API,

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 i18n language tag , e.g. ?locale=zh_CN

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.

You can easily pass the cache, use different value for cache-modifier, eg: ?cache-modifier= 123

See the Resource Doc endpoint for more information.

Following are more examples:
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=zh_CN
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?cache-modifier=3141592653

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

URL Parameters:

API_VERSION:

JSON response body fields:

connector_methods: connector_methods

description: This an optional field. Maximum length is 2000. It can be any characters here.

description_markdown: description_markdown

error_response_bodies: OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.

example_request_body: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}

function: function

implemented_by: implemented_by

is_featured: false

operation_id: OBPv4.0.0-getBanks

request_url: /my_user/MY_USER_ID

request_verb: POST

resource_docs: resource_docs

special_instructions:

specified_url:

success_response_body: {"my_user_id": "some_id_value", "name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}

summary:

tags: Create-My-User

typed_request_body: typed_request_body

typed_success_response_body: typed_success_response_body

version:

created_by_bank_id: created_by_bank_id

meta:

roles: CanCreateMyUser

Respuesta Exitosa Típica:

								
									
{ "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 Mandatory</p>\n<p><strong>JSON response body fields:</strong></p>\n", "description_markdown":"I am only a test Resource Doc\n\nAuthentication is Mandatory\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.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "], "tags":["Documentation"], "typed_request_body":{ "type":"object", "properties":{ "jsonString":{ "type":"string" } } }, "typed_success_response_body":{ "type":"object", "properties":{ "jsonString":{ "type":"string" } } }, "roles":[{ "role":"CanGetCustomers", "requires_bank_id":true }], "is_featured":false, "special_instructions":"", "specified_url":"", "connector_methods":[] }] }
Roles Requeridos:
  • CanReadResourceDoc - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
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://api3.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger
https://api3.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
https://api3.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
https://api3.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById

Authentication is Optional

URL Parameters:

API_VERSION:

JSON response body fields:

Respuesta Exitosa Típica:

								
									
{ "jsonString":"{}" }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
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:

Respuesta Exitosa Típica:

								
									
{ "scanned_api_versions":[{ "urlPrefix":"obp", "apiStandard":"obp", "apiShortVersion":"v3.1.0", "API_VERSION":"v3.1.0" }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
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

Respuesta Exitosa Típica:

								
									
Roles Requeridos:
  • CanDeleteBankLevelDynamicEndpoint - Please login to request this Role
  • CanDeleteDynamicEndpoint - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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:
Métodos de conector::
Version: OBPv4.0.0, function_name: by deleteBankLevelDynamicEndpoint, operation_id: OBPv4.0.0-deleteBankLevelDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API,

Delete Dynamic Endpoint

Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
Roles Requeridos:
  • CanDeleteDynamicEndpoint - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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:
Métodos de conector::
Version: OBPv4.0.0, function_name: by deleteDynamicEndpoint, operation_id: OBPv4.0.0-deleteDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API,

Get Bank Level Dynamic Endpoint

Get a Bank Level Dynamic Endpoint.

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
{ "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"] } }
Roles Requeridos:
  • CanGetBankLevelDynamicEndpoint - Please login to request this Role
  • CanGetDynamicEndpoint - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getBankLevelDynamicEndpoint, operation_id: OBPv4.0.0-getBankLevelDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API,

Get Dynamic Endpoints

Get Dynamic Endpoints.

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
{ "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"] } }] }
Roles Requeridos:
  • CanGetDynamicEndpoints - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getDynamicEndpoints, operation_id: OBPv4.0.0-getDynamicEndpoints Tags: Dynamic-Endpoint-Manage, API,

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

Respuesta Exitosa Típica:

								
									
{ "host":"dynamic_entity" }
Roles Requeridos:
  • CanUpdateBankLevelDynamicEndpoint - Please login to request this Role
  • CanUpdateDynamicEndpoint - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by updateBankLevelDynamicEndpointHost, operation_id: OBPv4.0.0-updateBankLevelDynamicEndpointHost Tags: Dynamic-Endpoint-Manage, API,

Update Dynamic Endpoint Host

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

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
{ "host":"dynamic_entity" }
Roles Requeridos:
  • CanUpdateDynamicEndpoint - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by updateDynamicEndpointHost, operation_id: OBPv4.0.0-updateDynamicEndpointHost Tags: Dynamic-Endpoint-Manage, API,

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

Respuesta Exitosa Típica:

								
									
{ "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"] } }
Roles Requeridos:
  • CanCreateBankLevelDynamicEndpoint - Please login to request this Role
  • CanCreateDynamicEndpoint - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by createBankLevelDynamicEndpoint, operation_id: OBPv4.0.0-createBankLevelDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API,

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

Respuesta Exitosa Típica:

								
									
{ "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"] } }
Roles Requeridos:
  • CanCreateDynamicEndpoint - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by createDynamicEndpoint, operation_id: OBPv4.0.0-createDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API,

Delete My Dynamic Endpoint

Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by deleteMyDynamicEndpoint, operation_id: OBPv4.0.0-deleteMyDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API,

Get Bank Level Dynamic Endpoints

Get Bank Level Dynamic Endpoints.

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
{ "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"] } }] }
Roles Requeridos:
  • CanGetBankLevelDynamicEndpoints - Please login to request this Role
  • CanGetDynamicEndpoints - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getBankLevelDynamicEndpoints, operation_id: OBPv4.0.0-getBankLevelDynamicEndpoints Tags: Dynamic-Endpoint-Manage, API,

Get Dynamic Endpoint

Get a Dynamic Endpoint.

Get one DynamicEndpoint,

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
{ "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"] } }
Roles Requeridos:
  • CanGetDynamicEndpoint - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getDynamicEndpoint, operation_id: OBPv4.0.0-getDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API,

Get My Dynamic Endpoints

Get My Dynamic Endpoints.

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
{ "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"] } }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getMyDynamicEndpoints, operation_id: OBPv4.0.0-getMyDynamicEndpoints Tags: Dynamic-Endpoint-Manage, API,