right logo image
right logo image
Ingresar
⯆

API Explorer

Log off

v4.0.0 (541 APIs)

Anfitrión de la API: https://obp-apisandbox.joinfincubator.com
Banco
Cuentas
Vistas
Contrapartes
Transacciones

Create Bank Level Endpoint Tag

Create Bank Level Endpoint Tag

Note: Resource Docs are cached, TTL is 0 seconds

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.
Métodos de conector::
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

Note: Resource Docs are cached, TTL is 0 seconds

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.
Métodos de conector::
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:

Respuesta Exitosa Típica: 

								
									
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.
Métodos de conector::
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:

Respuesta Exitosa Típica: 

								
									
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.
Métodos de conector::
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: OBPv4.0.0, function_name: by root, operation_id: OBPv4.0.0-root Tags: API,

Get Adapter Info

Get basic information about the Adapter.

Authentication is Optional

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:
  • 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: OBPv3.1.0, function_name: by getAdapterInfo, operation_id: OBPv3.1.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.
Métodos de conector::
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).

Note: Rate limiting can be set at the Consumer level and also for anonymous calls.

See the consumer rate limits / call limits endpoints.

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, Rate-Limits,

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.

Note: Resource Docs are cached, TTL is 0 seconds

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.
Métodos de conector::
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.

Note: Resource Docs are cached, TTL is 0 seconds

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.
Métodos de conector::
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,