right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.0.0 filtered by tag: New-Style (510 APIs)

API Host: https://apisandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

Create Bank Level Endpoint Tag

Create Bank Level Endpoint Tag

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "bank_id":"gh.29.uk",
  "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "operation_id":"OBPv4.0.0-getBanks",
  "tag_name":"BankAccountTag1"
}
Required Roles:
  • CanCreateBankLevelEndpointTag - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createBankLevelEndpointTag, operation_id: OBPv4.0.0-createBankLevelEndpointTag Tags: API, API, New-Style,

Create System Level Endpoint Tag

Create System Level Endpoint Tag

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "bank_id":"gh.29.uk",
  "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "operation_id":"OBPv4.0.0-getBanks",
  "tag_name":"BankAccountTag1"
}
Required Roles:
  • CanCreateSystemLevelEndpointTag - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createSystemLevelEndpointTag, operation_id: OBPv4.0.0-createSystemLevelEndpointTag Tags: API, API, New-Style,

Delete Bank Level Endpoint Tag

Delete Bank Level Endpoint Tag.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

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

Delete System Level Endpoint Tag

Delete System Level Endpoint Tag.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "value":true
}
Required Roles:
  • CanDeleteSystemLevelEndpointTag - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteSystemLevelEndpointTag, operation_id: OBPv4.0.0-deleteSystemLevelEndpointTag Tags: API, API, New-Style,

Get API Configuration

Returns information about:

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

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{
  "akka":{
    "ports":[{
      "property":"default",
      "value":"8080"
    }],
    "log_level":"Debug",
    "remote_data_secret_matched":true
  },
  "elastic_search":{
    "metrics":[{
      "property":"String",
      "value":"Mapper"
    }],
    "warehouse":[{
      "property":"String",
      "value":"ElasticSearch"
    }]
  },
  "cache":[{
    "function_name":"getBanks",
    "ttl_in_seconds":5
  }],
  "scopes":{
    "require_scopes_for_all_roles":true,
    "require_scopes_for_listed_roles":["CanCreateUserAuthContextUpdate"]
  }
}
Required Roles:
  • CanGetConfig - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by config, operation_id: OBPv3.1.0-config Tags: API, New-Style,

Get API Info (root)

Returns information about:

  • API version
  • Hosted by information
  • Hosted at information
  • Energy source information
  • Git Commit

Authentication is Optional

JSON response body fields:

Typical Successful Response:

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

Get Adapter Info

Get basic information about the Adapter.

Authentication is Optional

JSON response body fields:

  • [date](/glossary#Scenario 6: Update credit score based on transaction and device data.): 2020-01-27

  • git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

  • name: ACCOUNT_MANAGEMENT_FEE

Typical Successful Response:

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

Get Adapter Info for a bank

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

Authentication is Optional

URL Parameters:

JSON response body fields:

  • [date](/glossary#Scenario 6: Update credit score based on transaction and device data.): 2020-01-27

  • git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

  • name: ACCOUNT_MANAGEMENT_FEE

Typical Successful Response:

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

Get Bank Level Endpoint Tags

Get Bank Level Endpoint Tags.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
[{
  "bank_id":"gh.29.uk",
  "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "operation_id":"OBPv4.0.0-getBanks",
  "tag_name":"BankAccountTag1"
}]
Required Roles:
  • CanGetBankLevelEndpointTag - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getBankLevelEndpointTags, operation_id: OBPv4.0.0-getBankLevelEndpointTags Tags: API, API, New-Style,

Get Connector Status (Loopback)

This endpoint makes a call to the Connector to check the backend transport (e.g. Kafka) is reachable.

Currently this is only implemented for Kafka based connectors.

For Kafka based connectors, this endpoint writes a message to Kafka and reads it again.

In the future, this endpoint may also return information about database connections etc.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

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

Get JSON Web Key (JWK)

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

Authentication is Optional

JSON response body fields:

Typical Successful Response:

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

Get JSON Web Key (JWK) URIs

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

Authentication is Optional

JSON response body fields:

Typical Successful Response:

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

Get Mapper Database Info

Get basic information about the Mapper Database.

Authentication is Mandatory

JSON response body fields:

  • [date](/glossary#Scenario 6: Update credit score based on transaction and device data.): 2020-01-27

  • git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

  • name: ACCOUNT_MANAGEMENT_FEE

Typical Successful Response:

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

Get Rate Limiting Info

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

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

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

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

Get System Level Endpoint Tags

Get System Level Endpoint Tags.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

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

Get the Call Context of a current call

Get the Call Context of the current call.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanGetCallContext - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by getCallContext, operation_id: OBPv4.0.0-getCallContext Tags: API, New-Style,

Update Bank Level Endpoint Tag

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

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "bank_id":"gh.29.uk",
  "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "operation_id":"OBPv4.0.0-getBanks",
  "tag_name":"BankAccountTag1"
}
Required Roles:
  • CanUpdateBankLevelEndpointTag - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30099: Invalid ENDPOINT_TAG_ID. Please specify a valid value for ENDPOINT_TAG_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateBankLevelEndpointTag, operation_id: OBPv4.0.0-updateBankLevelEndpointTag Tags: API, API, New-Style,

Update System Level Endpoint Tag

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

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "bank_id":"gh.29.uk",
  "endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "operation_id":"OBPv4.0.0-getBanks",
  "tag_name":"BankAccountTag1"
}
Required Roles:
  • CanUpdateSystemLevelEndpointTag - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-30099: Invalid ENDPOINT_TAG_ID. Please specify a valid value for ENDPOINT_TAG_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateSystemLevelEndpointTag, operation_id: OBPv4.0.0-updateSystemLevelEndpointTag Tags: API, API, New-Style,

Verify Request and Sign Response of a current call

Verify Request and Sign Response of a current call.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by verifyRequestSignResponse, operation_id: OBPv4.0.0-verifyRequestSignResponse Tags: API, New-Style,

Create ATM

Create ATM.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "bank_id":"gh.29.uk",
  "name":"Atm by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":11.45,
    "longitude":11.45
  },
  "meta":{
    "license":{
      "id":"ODbL-1.0",
      "name":"Open Database License"
    }
  },
  "monday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "tuesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "wednesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "thursday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "friday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "saturday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "sunday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "is_accessible":"true",
  "located_at":"no-example-provided",
  "more_info":"More information about this fee",
  "has_deposit_capability":"true",
  "supported_languages":["es","fr","de"],
  "services":["ATBP","ATBA"],
  "accessibility_features":["ATAC","ATAD"],
  "supported_currencies":["EUR","MXN","USD"],
  "notes":["String1","String2"],
  "location_categories":["ATBI","ATBE"],
  "minimum_withdrawal":"5",
  "branch_identification":"no-example-provided",
  "site_identification":"no-example-provided",
  "site_name":"no-example-provided",
  "cash_withdrawal_national_fee":"no-example-provided",
  "cash_withdrawal_international_fee":"no-example-provided",
  "balance_inquiry_fee":"no-example-provided"
}
Required Roles:
  • CanCreateAtm - Please login to request this Role
  • CanCreateAtmAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by createAtm, operation_id: OBPv4.0.0-createAtm Tags: ATM, New-Style,

Delete ATM

Delete ATM.

Authentication is Mandatory

URL Parameters:

  • ATM_ID: atme0352a-9a0f-4bfa-b30b-9003aa467f51

  • BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

								
									
{
  "id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "bank_id":"gh.29.uk",
  "name":"Atm by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":11.45,
    "longitude":11.45
  },
  "meta":{
    "license":{
      "id":"ODbL-1.0",
      "name":"Open Database License"
    }
  },
  "monday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "tuesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "wednesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "thursday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "friday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "saturday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "sunday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "is_accessible":"true",
  "located_at":"no-example-provided",
  "more_info":"More information about this fee",
  "has_deposit_capability":"true",
  "supported_languages":["es","fr","de"],
  "services":["ATBP","ATBA"],
  "accessibility_features":["ATAC","ATAD"],
  "supported_currencies":["EUR","MXN","USD"],
  "notes":["String1","String2"],
  "location_categories":["ATBI","ATBE"],
  "minimum_withdrawal":"5",
  "branch_identification":"no-example-provided",
  "site_identification":"no-example-provided",
  "site_name":"no-example-provided",
  "cash_withdrawal_national_fee":"no-example-provided",
  "cash_withdrawal_international_fee":"no-example-provided",
  "balance_inquiry_fee":"no-example-provided"
}
Required Roles:
  • CanDeleteAtmAtAnyBank - Please login to request this Role
  • CanDeleteAtm - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteAtm, operation_id: OBPv4.0.0-deleteAtm Tags: ATM, New-Style,

Get Bank ATM

Returns information about ATM for a single bank specified by BANK_ID and ATM_ID including:

  • Address
  • Geo Location
  • License the data under this endpoint is released under
    Authentication is Optional

URL Parameters:

  • ATM_ID: atme0352a-9a0f-4bfa-b30b-9003aa467f51

  • BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

								
									
{
  "id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "bank_id":"gh.29.uk",
  "name":"Atm by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":11.45,
    "longitude":11.45
  },
  "meta":{
    "license":{
      "id":"ODbL-1.0",
      "name":"Open Database License"
    }
  },
  "monday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "tuesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "wednesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "thursday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "friday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "saturday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "sunday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "is_accessible":"true",
  "located_at":"no-example-provided",
  "more_info":"More information about this fee",
  "has_deposit_capability":"true",
  "supported_languages":["es","fr","de"],
  "services":["ATBP","ATBA"],
  "accessibility_features":["ATAC","ATAD"],
  "supported_currencies":["EUR","MXN","USD"],
  "notes":["String1","String2"],
  "location_categories":["ATBI","ATBE"],
  "minimum_withdrawal":"5",
  "branch_identification":"no-example-provided",
  "site_identification":"no-example-provided",
  "site_name":"no-example-provided",
  "cash_withdrawal_national_fee":"no-example-provided",
  "cash_withdrawal_international_fee":"no-example-provided",
  "balance_inquiry_fee":"no-example-provided"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getAtm, operation_id: OBPv4.0.0-getAtm Tags: ATM, New-Style,

Get Bank ATMS

Get Bank ATMS.

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "atms":[{
    "id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
    "bank_id":"gh.29.uk",
    "name":"Atm by the Lake",
    "address":{
      "line_1":"No 1 the Road",
      "line_2":"The Place",
      "line_3":"The Hill",
      "city":"Berlin",
      "county":"",
      "state":"Brandenburg",
      "postcode":"13359",
      "country_code":"DE"
    },
    "location":{
      "latitude":11.45,
      "longitude":11.45
    },
    "meta":{
      "license":{
        "id":"ODbL-1.0",
        "name":"Open Database License"
      }
    },
    "monday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "tuesday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "wednesday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "thursday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "friday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "saturday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "sunday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "is_accessible":"true",
    "located_at":"no-example-provided",
    "more_info":"More information about this fee",
    "has_deposit_capability":"true",
    "supported_languages":["es","fr","de"],
    "services":["ATBP","ATBA"],
    "accessibility_features":["ATAC","ATAD"],
    "supported_currencies":["EUR","MXN","USD"],
    "notes":["String1","String2"],
    "location_categories":["ATBI","ATBE"],
    "minimum_withdrawal":"5",
    "branch_identification":"no-example-provided",
    "site_identification":"no-example-provided",
    "site_name":"no-example-provided",
    "cash_withdrawal_national_fee":"no-example-provided",
    "cash_withdrawal_international_fee":"no-example-provided",
    "balance_inquiry_fee":"no-example-provided"
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getAtms, operation_id: OBPv4.0.0-getAtms Tags: ATM, New-Style,

Head Bank ATMS

Head Bank ATMS.

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "atms":[{
    "id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
    "bank_id":"gh.29.uk",
    "name":"Atm by the Lake",
    "address":{
      "line_1":"No 1 the Road",
      "line_2":"The Place",
      "line_3":"The Hill",
      "city":"Berlin",
      "county":"",
      "state":"Brandenburg",
      "postcode":"13359",
      "country_code":"DE"
    },
    "location":{
      "latitude":11.45,
      "longitude":11.45
    },
    "meta":{
      "license":{
        "id":"ODbL-1.0",
        "name":"Open Database License"
      }
    },
    "monday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "tuesday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "wednesday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "thursday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "friday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "saturday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "sunday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "is_accessible":"true",
    "located_at":"no-example-provided",
    "more_info":"More information about this fee",
    "has_deposit_capability":"true",
    "supported_languages":["es","fr","de"],
    "services":["ATBP","ATBA"],
    "accessibility_features":["ATAC","ATAD"],
    "supported_currencies":["EUR","MXN","USD"],
    "notes":["String1","String2"],
    "location_categories":["ATBI","ATBE"],
    "minimum_withdrawal":"5",
    "branch_identification":"no-example-provided",
    "site_identification":"no-example-provided",
    "site_name":"no-example-provided",
    "cash_withdrawal_national_fee":"no-example-provided",
    "cash_withdrawal_international_fee":"no-example-provided",
    "balance_inquiry_fee":"no-example-provided"
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.0.0, function_name: by headAtms, operation_id: OBPv5.0.0-headAtms Tags: ATM, New-Style,

UPDATE ATM

Update ATM.

Authentication is Mandatory

URL Parameters:

  • ATM_ID: atme0352a-9a0f-4bfa-b30b-9003aa467f51

  • BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

								
									
{
  "id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "bank_id":"gh.29.uk",
  "name":"Atm by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":11.45,
    "longitude":11.45
  },
  "meta":{
    "license":{
      "id":"ODbL-1.0",
      "name":"Open Database License"
    }
  },
  "monday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "tuesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "wednesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "thursday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "friday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "saturday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "sunday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "is_accessible":"true",
  "located_at":"no-example-provided",
  "more_info":"More information about this fee",
  "has_deposit_capability":"true",
  "supported_languages":["es","fr","de"],
  "services":["ATBP","ATBA"],
  "accessibility_features":["ATAC","ATAD"],
  "supported_currencies":["EUR","MXN","USD"],
  "notes":["String1","String2"],
  "location_categories":["ATBI","ATBE"],
  "minimum_withdrawal":"5",
  "branch_identification":"no-example-provided",
  "site_identification":"no-example-provided",
  "site_name":"no-example-provided",
  "cash_withdrawal_national_fee":"no-example-provided",
  "cash_withdrawal_international_fee":"no-example-provided",
  "balance_inquiry_fee":"no-example-provided"
}
Required Roles:
  • CanUpdateAtm - Please login to request this Role
  • CanUpdateAtmAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by updateAtm, operation_id: OBPv4.0.0-updateAtm Tags: ATM, New-Style,

Update ATM Accessibility Features

Update ATM Accessibility Features.

Authentication is Mandatory

URL Parameters:

  • ATM_ID: atme0352a-9a0f-4bfa-b30b-9003aa467f51

  • BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

								
									
{
  "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "accessibility_features":["ATAC","ATAD"]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateAtmAccessibilityFeatures, operation_id: OBPv4.0.0-updateAtmAccessibilityFeatures Tags: ATM, New-Style,

Update ATM Location Categories

Update ATM Location Categories.

Authentication is Mandatory

URL Parameters:

  • ATM_ID: atme0352a-9a0f-4bfa-b30b-9003aa467f51

  • BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

								
									
{
  "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "location_categories":["ATBI","ATBE"]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateAtmLocationCategories, operation_id: OBPv4.0.0-updateAtmLocationCategories Tags: ATM, New-Style,

Update ATM Notes

Update ATM Notes.

Authentication is Mandatory

URL Parameters:

  • ATM_ID: atme0352a-9a0f-4bfa-b30b-9003aa467f51

  • BANK_ID: gh.29.uk

JSON response body fields:

  • atm_id: atme0352a-9a0f-4bfa-b30b-9003aa467f51

  • notes: notes

Typical Successful Response:

								
									
{
  "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "notes":["String1","String2"]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateAtmNotes, operation_id: OBPv4.0.0-updateAtmNotes Tags: ATM, New-Style,

Update ATM Services

Update ATM Services.

Authentication is Mandatory

URL Parameters:

  • ATM_ID: atme0352a-9a0f-4bfa-b30b-9003aa467f51

  • BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

								
									
{
  "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "services":["ATBP","ATBA"]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateAtmServices, operation_id: OBPv4.0.0-updateAtmServices Tags: ATM, New-Style,

Update ATM Supported Currencies

Update ATM Supported Currencies.

Authentication is Mandatory

URL Parameters:

  • ATM_ID: atme0352a-9a0f-4bfa-b30b-9003aa467f51

  • BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

								
									
{
  "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "supported_currencies":["EUR","MXN","USD"]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateAtmSupportedCurrencies, operation_id: OBPv4.0.0-updateAtmSupportedCurrencies Tags: ATM, New-Style,

Update ATM Supported Languages

Update ATM Supported Languages.

Authentication is Mandatory

URL Parameters:

  • ATM_ID: atme0352a-9a0f-4bfa-b30b-9003aa467f51

  • BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

								
									
{
  "atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
  "supported_languages":["es","fr","de"]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateAtmSupportedLanguages, operation_id: OBPv4.0.0-updateAtmSupportedLanguages Tags: ATM, New-Style,

Check Available Funds

Check Available Funds
Mandatory URL parameters:

  • amount=NUMBER
  • currency=STRING

Authentication is Mandatory

URL Parameters:

JSON response body fields:

  • [date](/glossary#Scenario 6: Update credit score based on transaction and device data.): 2020-01-27
Typical Successful Response:

								
									
{
  "answer":"yes",
  "date":"2022-09-12T20:14:21Z",
  "available_funds_request_id":"c4ykz59svsr9b7fmdxk8ezs7"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20054: Invalid amount. Please specify a valid value for amount.
  • OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by checkFundsAvailable, operation_id: OBPv3.1.0-checkFundsAvailable Tags: Account, Confirmation of Funds Service (PIIS), PSD2, New-Style,

Create Account (POST)

Create Account at bank specified by BANK_ID.

The User can create an Account for himself - or - the User that has the USER_ID specified in the POST body.

If the POST body USER_ID is specified, the logged in user must have the Role CanCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.

If the POST body USER_ID is not specified, the account will be owned by the logged in User.

The 'product_code' field SHOULD be a product_code from Product.
If the product_code matches a product_code from Product, account attributes will be created that match the Product Attributes.

Note: The Amount MUST be zero.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "label":"My Account",
  "product_code":"1234BW",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "branch_id":"DERBY6",
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "account_attributes":[{
    "product_code":"1234BW",
    "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
    "name":"OVERDRAFT_START_DATE",
    "type":"DATE_WITH_DAY",
    "value":"2012-04-23"
  }]
}
Required Roles:
  • CanCreateAccount - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-30106: Invalid Balance Amount.
  • OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00
  • OBP-30109: Initial Balance of Account must be Zero (0).
  • OBP-30105: Invalid Balance Currency.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by addAccount, operation_id: OBPv4.0.0-addAccount Tags: Account, New-Style,

Create Account Attribute

Create Account Attribute

Account Attributes are used to describe a financial Product with a list of typed key value pairs.

Each Account Attribute is linked to its Account by ACCOUNT_ID

Typical account attributes might be:

ISIN (for International bonds)
VKN (for German bonds)
REDCODE (markit short code for credit derivative)
LOAN_ID (e.g. used for Anacredit reporting)

ISSUE_DATE (When the bond was issued in the market)
MATURITY_DATE (End of life time of a product)
TRADABLE

See FPML for more examples.

The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "product_code":"1234BW",
  "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "name":"OVERDRAFT_START_DATE",
  "type":"DATE_WITH_DAY",
  "value":"2012-04-23"
}
Required Roles:
  • CanCreateAccountAttributeAtOneBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv3.1.0, function_name: by createAccountAttribute, operation_id: OBPv3.1.0-createAccountAttribute Tags: Account, New-Style,

Create or Update Account Attribute Definition

Create or Update Account Attribute Definition

The category field must be Account

The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "bank_id":"gh.29.uk",
  "name":"SPECIAL_TAX_NUMBER",
  "category":"Account",
  "type":"STRING",
  "description":"description",
  "alias":"STRING",
  "can_be_seen_on_views":["bank"],
  "is_active":true
}
Required Roles:
  • CanCreateAccountAttributeDefinitionAtOneBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by createOrUpdateAccountAttributeDefinition, operation_id: OBPv4.0.0-createOrUpdateAccountAttributeDefinition Tags: Account, New-Style,

Delete Account Attribute Definition

Delete Account Attribute Definition by ATTRIBUTE_DEFINITION_ID

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteAccountAttributeDefinitionAtOneBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteAccountAttributeDefinition, operation_id: OBPv4.0.0-deleteAccountAttributeDefinition Tags: Account, New-Style,

Delete Account Cascade

Delete an Account Cascade specified by ACCOUNT_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteAccountCascade - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteAccountCascade, operation_id: OBPv4.0.0-deleteAccountCascade Tags: Account, New-Style,

Get Account Attribute Definition

Get Account Attribute Definition

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "attributes":[{
    "attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "bank_id":"gh.29.uk",
    "name":"SPECIAL_TAX_NUMBER",
    "category":"Account",
    "type":"STRING",
    "description":"description",
    "alias":"STRING",
    "can_be_seen_on_views":["bank"],
    "is_active":true
  }]
}
Required Roles:
  • CanGetAccountAttributeDefinitionAtOneBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by getAccountAttributeDefinition, operation_id: OBPv4.0.0-getAccountAttributeDefinition Tags: Account, New-Style,

Get Account Balances

Get the Balances for one Account of the current User at one bank.

Authentication is Mandatory

URL Parameters:

JSON response body fields: