API Explorer

organisation_website:

energy_source:

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

hosted_at:

hosted_by:

hostname: hostname

local_identity_provider: local_identity_provider

organisation:

phone:

resource_docs_requires_role: resource_docs_requires_role

version_status:

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
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.
no connector set

Connector Methods:

Version: OBPv5.1.0, function_name: by root, operation_id: OBPv5.1.0-root Tags: API,

Get API Tags

Get API TagsGet API Tags

User Authentication is Optional. The User need not be logged in.

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

view_id: owner

Typical Successful Response:

								
									{
  "accounts":[{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "view_id":"owner"
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv5.1.0, function_name: by getApiTags, operation_id: OBPv5.1.0-getApiTags Tags: API,

Get Adapter Info

Get basic information about the Adapter.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

backend_messages: backend_messages

date: 2020-01-27

errorCode: errorCode

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

name: ACCOUNT_MANAGEMENT_FEE

text:

total_duration: total_duration

duration: 5.123

Typical Successful Response:

								
									{
  "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"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetAdapterInfo - 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: 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.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

date: 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"
}

Request Headers:

Response Headers:

Required Roles:

CanGetAdapterInfoAtOneBank - 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.0.0, function_name: by getAdapterInfoForBank, operation_id: OBPv3.0.0-getAdapterInfoForBank Tags: API,

Get Bank Level Endpoint Tags

Get Bank Level Endpoint Tags.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

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

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"
}]

Request Headers:

Response Headers:

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,

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.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

connector_version:

duration_time: 60

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

Typical Successful Response:

								
									{
  "connector_version":"kafka_vSept2018",
  "git_commit":"f0acd4be14cdcb94be3433ec95c1ad65228812a0",
  "duration_time":"10 ms"
}

Request Headers:

Response Headers:

Required Roles:

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,

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.

User Authentication is Optional. The User need not be logged in.

JSON response body fields:

e:

kid:

kty:

n:

use:

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

Request Headers:

Response Headers:

Required Roles:

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,

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.

User Authentication is Optional. The User need not be logged in.

JSON response body fields:

jwks_uri:

jwks_uris:

Typical Successful Response:

								
									{
  "jwks_uris":[{
    "jwks_uri":"https://www.googleapis.com/oauth2/v3/certs"
  }]
}

Request Headers:

Response Headers:

Required Roles:

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,

Get Mapper Database Info

Get basic information about the Mapper Database.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

date: 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"
}

Request Headers:

Response Headers:

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,

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.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

enabled: false

is_active: false

service_available:

technology: technology1

Typical Successful Response:

								
									{
  "enabled":true,
  "technology":"REDIS",
  "service_available":true,
  "is_active":true
}

Request Headers:

Response Headers:

Required Roles:

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

Get Suggested Session Timeout

Returns information about:

Suggested session timeout in case of a user inactivity

User Authentication is Optional. The User need not be logged in.

JSON response body fields:

timeout_in_seconds: timeout_in_seconds

Typical Successful Response:

								
									{
  "timeout_in_seconds":"300"
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv5.1.0, function_name: by suggestedSessionTimeout, operation_id: OBPv5.1.0-suggestedSessionTimeout Tags: API,

Get System Level Endpoint Tags

Get System Level Endpoint Tags.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

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

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"
}]

Request Headers:

Response Headers:

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,

Get the Call Context of a current call

Get the Call Context of the current call.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

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,

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 3600 seconds

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

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

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

Request Headers:

Response Headers:

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,

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 3600 seconds

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

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

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

Request Headers:

Response Headers:

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,

Verify Request and Sign Response of a current call

Verify Request and Sign Response of a current call.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

Required Roles:

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,

Waiting For Godot

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

User Authentication is Optional. The User need not be logged in.

JSON response body fields:

sleep_in_milliseconds: sleep_in_milliseconds

Typical Successful Response:

								
									{
  "sleep_in_milliseconds":50
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.
no connector set

Connector Methods:

Version: OBPv5.1.0, function_name: by waitingForGodot, operation_id: OBPv5.1.0-waitingForGodot Tags: API,

Create ATM

Create ATM.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

accessibility_features: ["ATAC","ATAD"]

bank_id: gh.29.uk

branch_identification: branch_identification

closing_time: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

location_categories: location_categories

longitude: -77.0364

minimum_withdrawal: minimum_withdrawal

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

notes: notes

services: services

site_identification: site_identification

site_name: site_name

supported_currencies: ["EUR","MXN","USD"]

supported_languages: ["es","fr","de"]

thursday:

tuesday:

wednesday:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

JSON response body fields:

accessibility_features: ["ATAC","ATAD"]

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

atm_id: atme-9a0f-4bfa-b30b-9003aa467f51

bank_id: gh.29.uk

branch_identification: branch_identification

closing_time: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

location_categories: location_categories

longitude: -77.0364

minimum_withdrawal: minimum_withdrawal

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

notes: notes

services: services

site_identification: site_identification

site_name: site_name

supported_currencies: ["EUR","MXN","USD"]

supported_languages: ["es","fr","de"]

value: 5987953

attributes: attribute value in form of (name, value)

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_active: false

Typical Successful Response:

								
									{
  "id":"atme-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":"false",
  "located_at":"",
  "more_info":"More information about this fee",
  "has_deposit_capability":"false",
  "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":"",
  "site_identification":"",
  "site_name":"",
  "cash_withdrawal_national_fee":"",
  "cash_withdrawal_international_fee":"",
  "balance_inquiry_fee":"",
  "atm_type":"",
  "phone":"",
  "attributes":[{
    "bank_id":"gh.29.uk",
    "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
    "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "type":"",
    "value":"5987953",
    "is_active":false
  }]
}

Request Headers:

Response Headers:

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: OBPv5.1.0, function_name: by createAtm, operation_id: OBPv5.1.0-createAtm Tags: ATM,

Create ATM Attribute

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON request body fields:

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

is_active: false

JSON response body fields:

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

atm_id: atme-9a0f-4bfa-b30b-9003aa467f51

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

is_active: false

Typical Successful Response:

								
									{
  "bank_id":"gh.29.uk",
  "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
  "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
  "name":"ACCOUNT_MANAGEMENT_FEE",
  "type":"",
  "value":"5987953",
  "is_active":false
}

Request Headers:

Response Headers:

Required Roles:

CanCreateAtmAttribute - Please login to request this Role
CanCreateAtmAttributeAtAnyBank - 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: OBPv5.1.0, function_name: by createAtmAttribute, operation_id: OBPv5.1.0-createAtmAttribute Tags: ATM,

Delete ATM

Delete ATM.

This will also delete all its attributes.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

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: OBPv5.1.0, function_name: by deleteAtm, operation_id: OBPv5.1.0-deleteAtm Tags: ATM,

Delete ATM Attribute

Delete a Atm Attribute by its id.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATM_ATTRIBUTE_ID: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

Required Roles:

CanDeleteAtmAttribute - Please login to request this Role
CanDeleteAtmAttributeAtAnyBank - 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: OBPv5.1.0, function_name: by deleteAtmAttribute, operation_id: OBPv5.1.0-deleteAtmAttribute Tags: ATM,

Get ATM Attribute By ATM_ATTRIBUTE_ID

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATM_ATTRIBUTE_ID: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

atm_id: atme-9a0f-4bfa-b30b-9003aa467f51

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

is_active: false

Typical Successful Response:

								
									{
  "bank_id":"gh.29.uk",
  "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
  "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
  "name":"ACCOUNT_MANAGEMENT_FEE",
  "type":"",
  "value":"5987953",
  "is_active":false
}

Request Headers:

Response Headers:

Required Roles:

CanGetAtmAttribute - Please login to request this Role
CanGetAtmAttributeAtAnyBank - 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: OBPv5.1.0, function_name: by getAtmAttribute, operation_id: OBPv5.1.0-getAtmAttribute Tags: ATM,

Get ATM Attributes

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

atm_attributes: atm_attributes

atm_id: atme-9a0f-4bfa-b30b-9003aa467f51

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

is_active: false

Typical Successful Response:

								
									{
  "atm_attributes":[{
    "bank_id":"gh.29.uk",
    "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
    "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "type":"",
    "value":"5987953",
    "is_active":false
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetAtmAttribute - Please login to request this Role
CanGetAtmAttributeAtAnyBank - 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: OBPv5.1.0, function_name: by getAtmAttributes, operation_id: OBPv5.1.0-getAtmAttributes Tags: ATM,

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
ATM Attributes

User Authentication is Optional. The User need not be logged in.

URL Parameters:

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

accessibility_features: ["ATAC","ATAD"]

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

atm_id: atme-9a0f-4bfa-b30b-9003aa467f51

bank_id: gh.29.uk

branch_identification: branch_identification

closing_time: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

location_categories: location_categories

longitude: -77.0364

minimum_withdrawal: minimum_withdrawal

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

notes: notes

services: services

site_identification: site_identification

site_name: site_name

supported_currencies: ["EUR","MXN","USD"]

supported_languages: ["es","fr","de"]

value: 5987953

attributes: attribute value in form of (name, value)

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_active: false

Typical Successful Response:

								
									{
  "id":"atme-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":"false",
  "located_at":"",
  "more_info":"More information about this fee",
  "has_deposit_capability":"false",
  "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":"",
  "site_identification":"",
  "site_name":"",
  "cash_withdrawal_national_fee":"",
  "cash_withdrawal_international_fee":"",
  "balance_inquiry_fee":"",
  "atm_type":"",
  "phone":"",
  "attributes":[{
    "bank_id":"gh.29.uk",
    "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
    "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "type":"",
    "value":"5987953",
    "is_active":false
  }]
}

Request Headers:

Response Headers:

Required Roles:

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-30009: ATM not found. Please specify a valid value for ATM_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv5.1.0, function_name: by getAtm, operation_id: OBPv5.1.0-getAtm Tags: ATM,

Get Bank ATMS

Returns information about ATMs for a single bank specified by BANK_ID including:

Address
Geo Location
License the data under this endpoint is released under

Pagination:

By default, 100 records are returned.

You can use the url query parameters limit and offset for pagination

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

accessibility_features: ["ATAC","ATAD"]

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

atm_id: atme-9a0f-4bfa-b30b-9003aa467f51

atms:

bank_id: gh.29.uk

branch_identification: branch_identification

closing_time: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

location_categories: location_categories

longitude: -77.0364

minimum_withdrawal: minimum_withdrawal

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

notes: notes

services: services

site_identification: site_identification

site_name: site_name

supported_currencies: ["EUR","MXN","USD"]

supported_languages: ["es","fr","de"]

value: 5987953

attributes: attribute value in form of (name, value)

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_active: false

Typical Successful Response:

								
									{
  "atms":[{
    "id":"atme-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":"false",
    "located_at":"",
    "more_info":"More information about this fee",
    "has_deposit_capability":"false",
    "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":"",
    "site_identification":"",
    "site_name":"",
    "cash_withdrawal_national_fee":"",
    "cash_withdrawal_international_fee":"",
    "balance_inquiry_fee":"",
    "atm_type":"",
    "phone":"",
    "attributes":[{
      "bank_id":"gh.29.uk",
      "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
      "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
      "name":"ACCOUNT_MANAGEMENT_FEE",
      "type":"",
      "value":"5987953",
      "is_active":false
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

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.1.0, function_name: by getAtms, operation_id: OBPv5.1.0-getAtms Tags: ATM,

Head Bank ATMS

Head Bank ATMS.

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

accessibility_features: ["ATAC","ATAD"]

atms:

bank_id: gh.29.uk

branch_identification: branch_identification

closing_time: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

location_categories: location_categories

longitude: -77.0364

minimum_withdrawal: minimum_withdrawal

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

notes: notes

opening_time:

postcode:

saturday:

services: services

site_identification: site_identification

site_name: site_name

supported_currencies: ["EUR","MXN","USD"]

supported_languages: ["es","fr","de"]

thursday:

tuesday:

wednesday:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

Typical Successful Response:

								
									{
  "atms":[{
    "id":"atme-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":"false",
    "located_at":"",
    "more_info":"More information about this fee",
    "has_deposit_capability":"false",
    "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":"",
    "site_identification":"",
    "site_name":"",
    "cash_withdrawal_national_fee":"",
    "cash_withdrawal_international_fee":"",
    "balance_inquiry_fee":""
  }]
}

Request Headers:

Response Headers:

Required Roles:

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,

UPDATE ATM

Update ATM.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

accessibility_features: ["ATAC","ATAD"]

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

atm_id: atme-9a0f-4bfa-b30b-9003aa467f51

bank_id: gh.29.uk

branch_identification: branch_identification

closing_time: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

location_categories: location_categories

longitude: -77.0364

minimum_withdrawal: minimum_withdrawal

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

notes: notes

services: services

site_identification: site_identification

site_name: site_name

supported_currencies: ["EUR","MXN","USD"]

supported_languages: ["es","fr","de"]

value: 5987953

attributes: attribute value in form of (name, value)

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_active: false

Typical Successful Response:

								
									{
  "id":"atme-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":"false",
  "located_at":"",
  "more_info":"More information about this fee",
  "has_deposit_capability":"false",
  "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":"",
  "site_identification":"",
  "site_name":"",
  "cash_withdrawal_national_fee":"",
  "cash_withdrawal_international_fee":"",
  "balance_inquiry_fee":"",
  "atm_type":"",
  "phone":"",
  "attributes":[{
    "bank_id":"gh.29.uk",
    "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
    "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "type":"",
    "value":"5987953",
    "is_active":false
  }]
}

Request Headers:

Response Headers:

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: OBPv5.1.0, function_name: by updateAtm, operation_id: OBPv5.1.0-updateAtm Tags: ATM,

Update ATM Accessibility Features

Update ATM Accessibility Features.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

accessibility_features: ["ATAC","ATAD"]

atm_id: atme-9a0f-4bfa-b30b-9003aa467f51

Typical Successful Response:

								
									{
  "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
  "accessibility_features":["ATAC","ATAD"]
}

Request Headers:

Response Headers:

Required Roles:

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,

Update ATM Attribute

Update ATM Attribute.

Update an ATM Attribute by its id.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATM_ATTRIBUTE_ID: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

atm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51

atm_id: atme-9a0f-4bfa-b30b-9003aa467f51

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

available_funds_request_id:

value: 5987953

is_active: false

Typical Successful Response:

								
									{
  "bank_id":"gh.29.uk",
  "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
  "atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51",
  "name":"ACCOUNT_MANAGEMENT_FEE",
  "type":"",
  "value":"5987953",
  "is_active":false
}

Request Headers:

Response Headers:

Required Roles:

CanUpdateAtmAttribute - Please login to request this Role
CanUpdateAtmAttributeAtAnyBank - 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: OBPv5.1.0, function_name: by updateAtmAttribute, operation_id: OBPv5.1.0-updateAtmAttribute Tags: ATM,

Update ATM Location Categories

Update ATM Location Categories.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

atm_id: atme-9a0f-4bfa-b30b-9003aa467f51

location_categories: location_categories

Typical Successful Response:

								
									{
  "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
  "location_categories":["ATBI","ATBE"]
}

Request Headers:

Response Headers:

Required Roles:

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,

Update ATM Notes

Update ATM Notes.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

atm_id: atme-9a0f-4bfa-b30b-9003aa467f51

notes: notes

Typical Successful Response:

								
									{
  "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
  "notes":["String1","String2"]
}

Request Headers:

Response Headers:

Required Roles:

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,

Update ATM Services

Update ATM Services.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

atm_id: atme-9a0f-4bfa-b30b-9003aa467f51

services: services

Typical Successful Response:

								
									{
  "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
  "services":["ATBP","ATBA"]
}

Request Headers:

Response Headers:

Required Roles:

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,

Update ATM Supported Currencies

Update ATM Supported Currencies.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

atm_id: atme-9a0f-4bfa-b30b-9003aa467f51

supported_currencies: ["EUR","MXN","USD"]

Typical Successful Response:

								
									{
  "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
  "supported_currencies":["EUR","MXN","USD"]
}

Request Headers:

Response Headers:

Required Roles:

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,

Update ATM Supported Languages

Update ATM Supported Languages.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51

BANK_ID: gh.29.uk

JSON response body fields:

atm_id: atme-9a0f-4bfa-b30b-9003aa467f51

supported_languages: ["es","fr","de"]

Typical Successful Response:

								
									{
  "atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51",
  "supported_languages":["es","fr","de"]
}

Request Headers:

Response Headers:

Required Roles:

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,

Check Available Funds

Check Available Funds
Mandatory URL parameters:

amount=NUMBER
currency=STRING

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

answer:

date: 2020-01-27

Typical Successful Response:

								
									{
  "answer":"yes",
  "date":"2025-03-17T21:00:29Z",
  "available_funds_request_id":"c4ykz59svsr9b7fmdxk8ezs7"
}

Request Headers:

Response Headers:

Required Roles:

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,

Create Account (POST)

Create Account at bank specified by BANK_ID.

The User can create an Account for themself - 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.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

amount: 10.12

branch_id: DERBY6

label: My Account

product_code: 1234BW

scheme: OBP

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

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

amount: 10.12

branch_id: DERBY6

label: My Account

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

scheme: OBP

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

value: 5987953

product_instance_code: product_instance_code

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":"OBP",
    "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  }],
  "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",
    "product_instance_code":"LKJL98769F"
  }]
}

Request Headers:

Response Headers:

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,

Create Account (PUT)

Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.

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

If the PUT 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 PUT 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.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

amount: 10.12

branch_id: DERBY6

label: My Account

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

scheme: OBP

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

value: 5987953

product_instance_code: product_instance_code

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":"OBP",
    "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  }],
  "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",
    "product_instance_code":"LKJL98769F"
  }]
}

Request Headers:

Response Headers:

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-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-20001: User not logged in. Authentication is required!
OBP-30107: Invalid User Id.
OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
OBP-20005: User not found. Please specify a valid value for USER_ID.
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-30208: Account_ID already exists at the Bank.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv5.0.0, function_name: by createAccount, operation_id: OBPv5.0.0-createAccount Tags: Account, Onboarding,

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"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON request body fields:

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

product_instance_code: product_instance_code

JSON response body fields:

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

value: 5987953

product_instance_code: product_instance_code

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",
  "product_instance_code":"LKJL98769F"
}

Request Headers:

Response Headers:

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,

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_id: gh.29.uk

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_active: false

name: ACCOUNT_MANAGEMENT_FEE

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
}

Request Headers:

Response Headers:

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,

Delete Account Attribute Definition

Delete Account Attribute Definition by ATTRIBUTE_DEFINITION_ID

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATTRIBUTE_DEFINITION_ID:

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

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,

Delete Account Cascade

Delete an Account Cascade specified by ACCOUNT_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

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,

Get Account Access by USER_ID

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

view_id: owner

Typical Successful Response:

								
									{
  "accounts":[{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "view_id":"owner"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanSeeAccountAccessForAnyUser - 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-20057: User not found by userId.
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv5.1.0, function_name: by getAccountAccessByUserId, operation_id: OBPv5.1.0-getAccountAccessByUserId Tags: Account,

Get Account Attribute Definition

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

attributes: attribute value in form of (name, value)

bank_id: gh.29.uk

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_active: false

name: ACCOUNT_MANAGEMENT_FEE

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

Request Headers:

Response Headers:

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,

Get Account Balances

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

amount: 10.12

balances: balances

bank_id: gh.29.uk

label: My Account

scheme: OBP

Typical Successful Response:

								
									{
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "account_routings":[{
    "scheme":"accountNumber",
    "address":"123456"
  }],
  "label":"My Account",
  "balances":[{
    "type":"",
    "currency":"EUR",
    "amount":"10"
  }]
}

Request Headers:

Response Headers:

Required Roles:

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-30065: Cannot find account access.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getBankAccountBalancesForCurrentUser, operation_id: OBPv4.0.0-getBankAccountBalancesForCurrentUser Tags: Account, Account Information Service (AIS), PSD2,

Get Account Balances by BANK_ID

Get the Balances for the Account specified by BANK_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

amount: 10.12

balances: balances

bank_id: gh.29.uk

label: My Account

scheme: OBP

Typical Successful Response:

								
									{
  "accounts":[{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "account_routings":[{
      "scheme":"accountNumber",
      "address":"123456"
    }],
    "label":"My Account",
    "balances":[{
      "type":"",
      "currency":"EUR",
      "amount":"10"
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

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.

Connector Methods:

Version: OBPv5.1.0, function_name: by getBankAccountsBalances, operation_id: OBPv5.1.0-getBankAccountsBalances Tags: Account, Account Information Service (AIS), PSD2,

Get Account Balances by BANK_ID

Get the Balances for the Account specified by BANK_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

amount: 10.12

balances: balances

bank_id: gh.29.uk

label: My Account

scheme: OBP

Typical Successful Response:

								
									{
  "accounts":[{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "account_routings":[{
      "scheme":"accountNumber",
      "address":"123456"
    }],
    "label":"My Account",
    "balances":[{
      "type":"",
      "currency":"EUR",
      "amount":"10"
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

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.

Connector Methods:

Version: OBPv5.1.0, function_name: by getBankAccountsBalancesThroughView, operation_id: OBPv5.1.0-getBankAccountsBalancesThroughView Tags: Account, Account Information Service (AIS), PSD2,

Get Account Balances by BANK_ID and ACCOUNT_ID through the VIEW_ID

Get the Balances for the Account specified by BANK_ID and ACCOUNT_ID through the VIEW_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

amount: 10.12

balances: balances

bank_id: gh.29.uk

label: My Account

scheme: OBP

Typical Successful Response:

								
									{
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "account_routings":[{
    "scheme":"accountNumber",
    "address":"123456"
  }],
  "label":"My Account",
  "balances":[{
    "type":"",
    "currency":"EUR",
    "amount":"10"
  }]
}

Request Headers:

Response Headers:

Required Roles:

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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv5.1.0, function_name: by getBankAccountBalances, operation_id: OBPv5.1.0-getBankAccountBalances Tags: Account, Account Information Service (AIS), PSD2,

Get Account by Account Routing

This endpoint returns the account (if it exists) linked with the provided scheme and address.

The bank_id field is optional, but if it's not provided, we don't guarantee that the returned account is unique across all the banks.

Example of account routing scheme: IBAN, "OBP", "AccountNumber", ...
Example of account routing address: DE17500105178275645584, "321774cc-fccd-11ea-adc1-0242ac120002", "55897106215", ...

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

account_routing:

scheme: OBP

bank_id: gh.29.uk

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

can_add_tag: false

can_see_other_account_national_identifier: false

can_see_url: false

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

provider: ETHEREUM

scheme: OBP

tags: Create-My-User

value: 5987953

product_instance_code: product_instance_code

Typical Successful Response:

								
									{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "label":"NoneLabel",
  "number":"123",
  "owners":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }],
  "product_code":"1234BW",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "views_available":[{
    "id":"123",
    "short_name":"short_name",
    "description":"description",
    "is_public":true,
    "alias":"None",
    "hide_metadata_if_alias_used":true,
    "can_add_comment":true,
    "can_add_corporate_location":true,
    "can_add_image":true,
    "can_add_image_url":true,
    "can_add_more_info":true,
    "can_add_open_corporates_url":true,
    "can_add_physical_location":true,
    "can_add_private_alias":true,
    "can_add_public_alias":true,
    "can_add_tag":true,
    "can_add_url":true,
    "can_add_where_tag":true,
    "can_delete_comment":true,
    "can_delete_corporate_location":true,
    "can_delete_image":true,
    "can_delete_physical_location":true,
    "can_delete_tag":true,
    "can_delete_where_tag":true,
    "can_edit_owner_comment":true,
    "can_see_bank_account_balance":true,
    "can_see_bank_account_bank_name":true,
    "can_see_bank_account_currency":true,
    "can_see_bank_account_iban":true,
    "can_see_bank_account_label":true,
    "can_see_bank_account_national_identifier":true,
    "can_see_bank_account_number":true,
    "can_see_bank_account_owners":true,
    "can_see_bank_account_swift_bic":true,
    "can_see_bank_account_type":true,
    "can_see_comments":true,
    "can_see_corporate_location":true,
    "can_see_image_url":true,
    "can_see_images":true,
    "can_see_more_info":true,
    "can_see_open_corporates_url":true,
    "can_see_other_account_bank_name":true,
    "can_see_other_account_iban":true,
    "can_see_other_account_kind":true,
    "can_see_other_account_metadata":true,
    "can_see_other_account_national_identifier":true,
    "can_see_other_account_number":true,
    "can_see_other_account_swift_bic":true,
    "can_see_owner_comment":true,
    "can_see_physical_location":true,
    "can_see_private_alias":true,
    "can_see_public_alias":true,
    "can_see_tags":true,
    "can_see_transaction_amount":true,
    "can_see_transaction_balance":true,
    "can_see_transaction_currency":true,
    "can_see_transaction_description":true,
    "can_see_transaction_finish_date":true,
    "can_see_transaction_metadata":true,
    "can_see_transaction_other_bank_account":true,
    "can_see_transaction_start_date":true,
    "can_see_transaction_this_bank_account":true,
    "can_see_transaction_type":true,
    "can_see_url":true,
    "can_see_where_tag":true
  }],
  "bank_id":"gh.29.uk",
  "account_routings":[{
    "scheme":"OBP",
    "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  }],
  "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",
    "product_instance_code":"LKJL98769F"
  }],
  "tags":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "value":"OBP",
    "date":"1100-01-01T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }
  }]
}

Request Headers:

Response Headers:

Required Roles:

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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getAccountByAccountRouting, operation_id: OBPv4.0.0-getAccountByAccountRouting Tags: Account,

Get Account by Id (Core)

Information returned about the account specified by ACCOUNT_ID:

Number - The human readable account number given by the bank that identifies the account.
Label - A label given by the owner of the account
Owners - Users that own this account
Type - The type of account
Balance - Currency and Value
Account Routings - A list that might include IBAN or national account identifiers
Account Rules - A list that might include Overdraft and other bank specific rules
Tags - A list of Tags assigned to this account

This call returns the owner view and requires access to that view.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

product_code: 1234BW

scheme: OBP

views_basic:

Typical Successful Response:

								
									{
  "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "bank_id":"gh.29.uk",
  "label":"My Account",
  "number":"546387432",
  "product_code":"AC",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "account_routings":[{
    "scheme":"OBP",
    "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  }],
  "views_basic":["owner"]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getCoreAccountById, operation_id: OBPv4.0.0-getCoreAccountById Tags: Account, Account Information Service (AIS), PSD2,

Get Account by Id (Core) through the VIEW_ID

Information returned about the account through VIEW_ID :

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

product_code: 1234BW

scheme: OBP

views_basic:

Typical Successful Response:

								
									{
  "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "bank_id":"gh.29.uk",
  "label":"My Account",
  "number":"546387432",
  "product_code":"AC",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "account_routings":[{
    "scheme":"OBP",
    "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  }],
  "views_basic":["owner"]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv5.1.0, function_name: by getCoreAccountByIdThroughView, operation_id: OBPv5.1.0-getCoreAccountByIdThroughView Tags: Account, Account Information Service (AIS), PSD2,

Get Account by Id (Full)

Information returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):

Number
Owners
Type
Balance
IBAN
Available views (sorted by short_name)

More details about the data moderation by the view here.

PSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
This call provides balance and other account information via delegated authentication using OAuth.

Authentication is required if the 'is_public' field in view (VIEW_ID) is not set to true.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

can_add_tag: false

can_see_other_account_national_identifier: false

can_see_url: false

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

provider: ETHEREUM

scheme: OBP

tags: Create-My-User

value: 5987953

product_instance_code: product_instance_code

Typical Successful Response:

								
									{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "label":"NoneLabel",
  "number":"123",
  "owners":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }],
  "product_code":"1234BW",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "views_available":[{
    "id":"123",
    "short_name":"short_name",
    "description":"description",
    "is_public":true,
    "alias":"None",
    "hide_metadata_if_alias_used":true,
    "can_add_comment":true,
    "can_add_corporate_location":true,
    "can_add_image":true,
    "can_add_image_url":true,
    "can_add_more_info":true,
    "can_add_open_corporates_url":true,
    "can_add_physical_location":true,
    "can_add_private_alias":true,
    "can_add_public_alias":true,
    "can_add_tag":true,
    "can_add_url":true,
    "can_add_where_tag":true,
    "can_delete_comment":true,
    "can_delete_corporate_location":true,
    "can_delete_image":true,
    "can_delete_physical_location":true,
    "can_delete_tag":true,
    "can_delete_where_tag":true,
    "can_edit_owner_comment":true,
    "can_see_bank_account_balance":true,
    "can_see_bank_account_bank_name":true,
    "can_see_bank_account_currency":true,
    "can_see_bank_account_iban":true,
    "can_see_bank_account_label":true,
    "can_see_bank_account_national_identifier":true,
    "can_see_bank_account_number":true,
    "can_see_bank_account_owners":true,
    "can_see_bank_account_swift_bic":true,
    "can_see_bank_account_type":true,
    "can_see_comments":true,
    "can_see_corporate_location":true,
    "can_see_image_url":true,
    "can_see_images":true,
    "can_see_more_info":true,
    "can_see_open_corporates_url":true,
    "can_see_other_account_bank_name":true,
    "can_see_other_account_iban":true,
    "can_see_other_account_kind":true,
    "can_see_other_account_metadata":true,
    "can_see_other_account_national_identifier":true,
    "can_see_other_account_number":true,
    "can_see_other_account_swift_bic":true,
    "can_see_owner_comment":true,
    "can_see_physical_location":true,
    "can_see_private_alias":true,
    "can_see_public_alias":true,
    "can_see_tags":true,
    "can_see_transaction_amount":true,
    "can_see_transaction_balance":true,
    "can_see_transaction_currency":true,
    "can_see_transaction_description":true,
    "can_see_transaction_finish_date":true,
    "can_see_transaction_metadata":true,
    "can_see_transaction_other_bank_account":true,
    "can_see_transaction_start_date":true,
    "can_see_transaction_this_bank_account":true,
    "can_see_transaction_type":true,
    "can_see_url":true,
    "can_see_where_tag":true
  }],
  "bank_id":"gh.29.uk",
  "account_routings":[{
    "scheme":"OBP",
    "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  }],
  "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",
    "product_instance_code":"LKJL98769F"
  }],
  "tags":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "value":"OBP",
    "date":"1100-01-01T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }
  }]
}

Request Headers:

Response Headers:

Required Roles:

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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getPrivateAccountByIdFull, operation_id: OBPv4.0.0-getPrivateAccountByIdFull Tags: Account,

Get Accounts Held

Get Accounts held by the current User if even the User has not been assigned the owner View yet.

Can be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.

optional request parameters:

account_type_filter: one or many accountType value, split by comma
account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE

whole url example:
/banks/BANK_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

scheme: OBP

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"7b97bd26-583b-4c3b-8282-55ea9d934aad",
    "label":"My Account",
    "bank_id":"123",
    "number":"123",
    "account_routings":[{
      "scheme":"OBP",
      "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

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: OBPv3.0.0, function_name: by getAccountsHeld, operation_id: OBPv3.0.0-getAccountsHeld Tags: Account, Account Information Service (AIS), View-Custom, PSD2,

Get Accounts Held By User

Get Accounts held by the User if even the User has not been assigned the owner View yet.

Can be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.

optional request parameters:

account_type_filter: one or many accountType value, split by comma
account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE

whole url example:
/users/USER_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

JSON response body fields:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

scheme: OBP

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"7b97bd26-583b-4c3b-8282-55ea9d934aad",
    "label":"My Account",
    "bank_id":"123",
    "number":"123",
    "account_routings":[{
      "scheme":"OBP",
      "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetAccountsHeldAtAnyBank - 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-20057: User not found by userId.
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv5.1.0, function_name: by getAccountsHeldByUser, operation_id: OBPv5.1.0-getAccountsHeldByUser Tags: Account,

Get Accounts Held By User

Get Accounts held by the User if even the User has not been assigned the owner View yet.

Can be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.

optional request parameters:

account_type_filter: one or many accountType value, split by comma
account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE

whole url example:
/users/USER_ID/banks/BANK_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

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

JSON response body fields:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

scheme: OBP

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"7b97bd26-583b-4c3b-8282-55ea9d934aad",
    "label":"My Account",
    "bank_id":"123",
    "number":"123",
    "account_routings":[{
      "scheme":"OBP",
      "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetAccountsHeldAtOneBank - Please login to request this Role
CanGetAccountsHeldAtAnyBank - 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-20057: User not found by userId.
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv5.1.0, function_name: by getAccountsHeldByUserAtBank, operation_id: OBPv5.1.0-getAccountsHeldByUserAtBank Tags: Account,

Get Accounts Minimal for a Customer

Get Accounts Minimal by CUSTOMER_ID

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

view_id: owner

Typical Successful Response:

								
									{
  "accounts":[{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "view_id":"owner"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetAccountsMinimalForCustomerAtAnyBank - 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-30002: Customer not found. Please specify a valid value for CUSTOMER_NUMBER.
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv4.0.0, function_name: by getAccountsMinimalByCustomerId, operation_id: OBPv4.0.0-getAccountsMinimalByCustomerId Tags: Account,

Get Accounts at Bank

Returns the list of accounts at BANK_ID that the user has access to.
For each account the API returns the account ID and the views available to the user..
Each account must have at least one private View.

optional request parameters for filter with attributes
URL params example: /banks/some-bank-id/accounts?&limit=50&offset=1

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "label":"NoneLabel",
    "bank_id":"gh.29.uk",
    "views_available":[{
      "id":"1",
      "short_name":"HHH",
      "is_public":true
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

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.

Connector Methods:

Version: OBPv4.0.0, function_name: by getPrivateAccountsAtOneBank, operation_id: OBPv4.0.0-getPrivateAccountsAtOneBank Tags: Account, PrivateData, PublicData,

Get Accounts at Bank (IDs only)

Returns only the list of accounts ids at BANK_ID that the user has access to.

Each account must have at least one private View.

For each account the API returns its account ID.

If you want to see more information on the Views, use the Account Detail call.

optional request parameters:

account_type_filter: one or many accountType value, split by comma
account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE

whole url example:
/banks/BANK_ID/accounts/account_ids/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf"
  }]
}

Request Headers:

Response Headers:

Required Roles:

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.

Connector Methods:

Version: OBPv3.0.0, function_name: by getPrivateAccountIdsbyBankId, operation_id: OBPv3.0.0-getPrivateAccountIdsbyBankId Tags: Account, Account Information Service (AIS), PSD2,

Get Accounts at Bank (Minimal)

Returns the minimal list of private accounts at BANK_ID that the user has access to.
For each account, the API returns the ID, routing addresses and the views available to the current user.

If you want to see more information on the Views, use the Account Detail call.

optional request parameters:

account_type_filter: one or many accountType value, split by comma
account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE

whole url example:
/banks/BANK_ID/accounts/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

account_type: AC

bank_id: gh.29.uk

description: Description of the object. Maximum length is 2000. It can be any characters here.

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

scheme: OBP

views:

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "label":"String",
    "bank_id":"gh.29.uk",
    "account_type":"330",
    "account_routings":[{
      "scheme":"OBP",
      "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    }],
    "views":[{
      "id":"owner",
      "short_name":"owner",
      "description":"This view is for the owner for the account.",
      "is_public":false
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

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.

Connector Methods:

Version: OBPv3.0.0, function_name: by privateAccountsAtOneBank, operation_id: OBPv3.0.0-privateAccountsAtOneBank Tags: Account, Account Information Service (AIS), PSD2,

Get Accounts at all Banks (private)

Returns the list of accounts containing private views for the user.
Each account lists the views available to the user.

optional request parameters:

account_type_filter: one or many accountType value, split by comma
account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE

whole url example:
/my/accounts?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

account_type: AC

bank_id: gh.29.uk

description: Description of the object. Maximum length is 2000. It can be any characters here.

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

scheme: OBP

views:

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "label":"String",
    "bank_id":"gh.29.uk",
    "account_type":"330",
    "account_routings":[{
      "scheme":"OBP",
      "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    }],
    "views":[{
      "id":"owner",
      "short_name":"owner",
      "description":"This view is for the owner for the account.",
      "is_public":false
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

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: OBPv3.0.0, function_name: by corePrivateAccountsAllBanks, operation_id: OBPv3.0.0-corePrivateAccountsAllBanks Tags: Account, Account Information Service (AIS), PrivateData, PSD2,

Get Accounts by Account Routing Regex

This endpoint returns an array of accounts matching the provided routing scheme and the routing address regex.

The bank_id field is optional.

Example of account routing scheme: IBAN, OBP, AccountNumber, ...
Example of account routing address regex: DE175.*, 55897106215-[A-Z]{3}, ...

This endpoint can be used to retrieve multiples accounts matching a same account routing address pattern.
For example, if you want to link multiple accounts having different currencies, you can create an account
with 123456789-EUR as Account Number and an other account with 123456789-USD as Account Number.
So we can identify the Account Number as 123456789, so to get all the accounts with the same account number
and the different currencies, we can use this body in the request :

{
   "bank_id": "BANK_ID",
   "account_routing": {
       "scheme": "AccountNumber",
       "address": "123456789-[A-Z]{3}"
   }
}

This request will returns the accounts matching the routing address regex (123456789-EUR and 123456789-USD).

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

account_routing:

scheme: OBP

bank_id: gh.29.uk

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

can_add_tag: false

can_see_other_account_national_identifier: false

can_see_url: false

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

provider: ETHEREUM

scheme: OBP

tags: Create-My-User

value: 5987953

product_instance_code: product_instance_code

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "label":"NoneLabel",
    "number":"123",
    "owners":[{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }],
    "product_code":"1234BW",
    "balance":{
      "currency":"EUR",
      "amount":"0"
    },
    "views_available":[{
      "id":"123",
      "short_name":"short_name",
      "description":"description",
      "is_public":true,
      "alias":"None",
      "hide_metadata_if_alias_used":true,
      "can_add_comment":true,
      "can_add_corporate_location":true,
      "can_add_image":true,
      "can_add_image_url":true,
      "can_add_more_info":true,
      "can_add_open_corporates_url":true,
      "can_add_physical_location":true,
      "can_add_private_alias":true,
      "can_add_public_alias":true,
      "can_add_tag":true,
      "can_add_url":true,
      "can_add_where_tag":true,
      "can_delete_comment":true,
      "can_delete_corporate_location":true,
      "can_delete_image":true,
      "can_delete_physical_location":true,
      "can_delete_tag":true,
      "can_delete_where_tag":true,
      "can_edit_owner_comment":true,
      "can_see_bank_account_balance":true,
      "can_see_bank_account_bank_name":true,
      "can_see_bank_account_currency":true,
      "can_see_bank_account_iban":true,
      "can_see_bank_account_label":true,
      "can_see_bank_account_national_identifier":true,
      "can_see_bank_account_number":true,
      "can_see_bank_account_owners":true,
      "can_see_bank_account_swift_bic":true,
      "can_see_bank_account_type":true,
      "can_see_comments":true,
      "can_see_corporate_location":true,
      "can_see_image_url":true,
      "can_see_images":true,
      "can_see_more_info":true,
      "can_see_open_corporates_url":true,
      "can_see_other_account_bank_name":true,
      "can_see_other_account_iban":true,
      "can_see_other_account_kind":true,
      "can_see_other_account_metadata":true,
      "can_see_other_account_national_identifier":true,
      "can_see_other_account_number":true,
      "can_see_other_account_swift_bic":true,
      "can_see_owner_comment":true,
      "can_see_physical_location":true,
      "can_see_private_alias":true,
      "can_see_public_alias":true,
      "can_see_tags":true,
      "can_see_transaction_amount":true,
      "can_see_transaction_balance":true,
      "can_see_transaction_currency":true,
      "can_see_transaction_description":true,
      "can_see_transaction_finish_date":true,
      "can_see_transaction_metadata":true,
      "can_see_transaction_other_bank_account":true,
      "can_see_transaction_start_date":true,
      "can_see_transaction_this_bank_account":true,
      "can_see_transaction_type":true,
      "can_see_url":true,
      "can_see_where_tag":true
    }],
    "bank_id":"gh.29.uk",
    "account_routings":[{
      "scheme":"OBP",
      "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    }],
    "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",
      "product_instance_code":"LKJL98769F"
    }],
    "tags":[{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "value":"OBP",
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"http://127.0.0.1:8080",
        "display_name":"OBP"
      }
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getAccountsByAccountRoutingRegex, operation_id: OBPv4.0.0-getAccountsByAccountRoutingRegex Tags: Account,

Get Agent

Get Agent.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

JSON response body fields:

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

agent_number: 5987953

bank_id: gh.29.uk

is_confirmed_agent: is_confirmed_agent

is_pending_agent: is_pending_agent

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

Typical Successful Response:

								
									{
  "agent_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "bank_id":"gh.29.uk",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+49 30 901820",
  "agent_number":"5987953",
  "currency":"EUR",
  "is_confirmed_agent":false,
  "is_pending_agent":true
}

Request Headers:

Response Headers:

Required Roles:

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-30201: Agent not found. Please specify a valid value for AGENT_ID.
OBP-30325: Agent Account Link not found.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv5.1.0, function_name: by getAgent, operation_id: OBPv5.1.0-getAgent Tags: Account,

Get Agents at Bank

Get Agents at Bank.

User Authentication is Optional. The User need not be logged in.

Possible custom url parameters for pagination:

limit=NUMBER ==> default value: 50
offset=NUMBER ==> default value: 0

eg1:?limit=100&offset=0

sort_direction=ASC/DESC ==> default value: DESC.

eg2:?limit=100&offset=0&sort_direction=ASC

from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).
to_date=DATE => example value: 2025-03-17T21:00:33.329Z. NOTE! The default value is now (2025-03-17T21:00:33.329Z).

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

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

agent_number: 5987953

agents: agents

legal_name: Eveline Tripman

Typical Successful Response:

								
									{
  "agents":[{
    "agent_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "legal_name":"Eveline Tripman",
    "agent_number":"5987953"
  }]
}

Request Headers:

Response Headers:

Required Roles:

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-30326: Agents not found.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv5.1.0, function_name: by getAgents, operation_id: OBPv5.1.0-getAgents Tags: Account,

Get Checkbook orders

Get all checkbook orders

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

account_type: AC

distribution_channel:

bank_id: gh.29.uk

branch_routings:

first_check_number:

number_of_checkbooks:

order:

order_date: 2020-01-27

scheme: OBP

Typical Successful Response:

								
									{
  "account":{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "account_type":"330",
    "account_routings":[{
      "scheme":"OBP",
      "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    }],
    "branch_routings":[{
      "scheme":"OBP",
      "address":"DERBY6"
    }]
  },
  "orders":[{
    "order":{
      "order_id":"xjksajfkj",
      "order_date":"07082013",
      "number_of_checkbooks":"4",
      "distribution_channel":"1201",
      "status":"2",
      "first_check_number":"5165276",
      "shipping_code":"1"
    }
  }]
}

Request Headers:

Response Headers:

Required Roles:

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-50211: Connector did not return the set of check book.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.1.0, function_name: by getCheckbookOrders, operation_id: OBPv3.1.0-getCheckbookOrders Tags: Account,

Get Fast Firehose Accounts at Bank

This endpoint allows bulk access to accounts.

optional pagination parameters for filter with accounts

Possible custom url parameters for pagination:

limit=NUMBER ==> default value: 50
offset=NUMBER ==> default value: 0

eg1:?limit=100&offset=0

sort_direction=ASC/DESC ==> default value: DESC.

eg2:?limit=100&offset=0&sort_direction=ASC

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

amount: 10.12

bank_id: gh.29.uk

code: 125

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

product_code: 1234BW

provider: ETHEREUM

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

user_name: felixsmith

value: 5987953

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "bank_id":"gh.29.uk",
    "label":"My Account",
    "number":"",
    "owners":[{
      "user_id":"b27327a2-a822-41e5-a909-0150da688939",
      "provider":"https://finx22openplatform.fintech-galaxy.com,user_name:synth_user_1_54891",
      "user_name":""
    }],
    "product_code":"1234BW",
    "balance":{
      "currency":"EUR",
      "amount":"0"
    },
    "account_routings":[{
      "bank_id":"bisb.com",
      "account_id":"c590e38e-847c-466f-9a62-f2ad67daf106"
    }],
    "account_attributes":[{
      "type":"INTEGER",
      "code":"Loan1",
      "value":"0"
    },{
      "type":"STRING",
      "code":"Loan1",
      "value":"4421.783"
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanUseAccountFirehoseAtAnyBank - Please login to request this Role
CanUseAccountFirehose - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv4.0.0, function_name: by getFastFirehoseAccountsAtOneBank, operation_id: OBPv4.0.0-getFastFirehoseAccountsAtOneBank Tags: Account, Account-Firehose, FirehoseData,

Get Firehose Accounts at Bank

Get Accounts which have a firehose view assigned to them.

This endpoint allows bulk access to accounts.

Requires the CanUseFirehoseAtAnyBank Role

To be shown on the list, each Account must have a firehose View linked to it.

A firehose view has is_firehose = true

For VIEW_ID try 'owner'

optional request parameters for filter with attributes
URL params example:
/banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1

to invalid Browser cache, add timestamp query parameter as follow, the parameter name must be _timestamp_
URL params example:
/banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1&_timestamp_=1596762180358

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

account_rules:

amount: 10.12

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

product_code: 1234BW

provider: ETHEREUM

scheme: OBP

value: 5987953

account_attributes:

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "bank_id":"gh.29.uk",
    "label":"My Account",
    "number":"",
    "owners":[{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }],
    "product_code":"1234BW",
    "balance":{
      "currency":"EUR",
      "amount":"0"
    },
    "account_routings":[{
      "scheme":"OBP",
      "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    }],
    "account_rules":[{
      "scheme":"OVERDRAFT",
      "value":"10"
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanUseAccountFirehoseAtAnyBank - Please login to request this Role
CanUseAccountFirehose - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv4.0.0, function_name: by getFirehoseAccountsAtOneBank, operation_id: OBPv4.0.0-getFirehoseAccountsAtOneBank Tags: Account, Account-Firehose, FirehoseData,

Update Account

Update the account.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

branch_id: DERBY6

label: My Account

scheme: OBP

Typical Successful Response:

								
									{
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "label":"Label",
  "type":"CURRENT",
  "branch_id":"1234",
  "account_routings":[{
    "scheme":"IBAN",
    "address":"DE91 1000 0000 0123 4567 89"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanUpdateAccount - 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-50000: Unknown Error.
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:

Connector Methods:

Version: OBPv3.1.0, function_name: by updateAccount, operation_id: OBPv3.1.0-updateAccount Tags: Account,

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ATTRIBUTE_ID:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON response body fields:

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

value: 5987953

product_instance_code: product_instance_code

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",
  "product_instance_code":"LKJL98769F"
}

Request Headers:

Response Headers:

Required Roles:

CanUpdateAccountAttribute - 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 updateAccountAttribute, operation_id: OBPv3.1.0-updateAccountAttribute Tags: Account,

Update Account Label

Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account'

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

JSON request body fields:

label: My Account

JSON response body fields:

success:

Typical Successful Response:

								
									{
  "success":"Success"
}

Request Headers:

Response Headers:

Required Roles:

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-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-50000: Unknown Error.
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
user does not have access to owner view on account

Connector Methods:

Version: OBPv4.0.0, function_name: by updateAccountLabel, operation_id: OBPv4.0.0-updateAccountLabel Tags: Account,

Validate and check IBAN

Validate and check IBAN for errors

User Authentication is Optional. The User need not be logged in.

JSON request body fields:

JSON response body fields:

attributes: attribute value in form of (name, value)

bank:

bank_routings: bank routing in form of (scheme, address)

branch: branch

GET https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current

country: Germany

is_valid: is_valid

name: ACCOUNT_MANAGEMENT_FEE

phone:

postcode:

scheme: OBP

value: 5987953

details:

Typical Successful Response:

								
									{
  "is_valid":true,
  "details":{
    "bank_routings":[{
      "scheme":"BIC",
      "address":"SOGEDEFF"
    }],
    "bank":"Societe Generale",
    "branch":"",
    "address":"Neue mainzer strasse 46-50",
    "city":"Frankfurt am Main",
    "postcode":"60311",
    "phone":"",
    "country":"Germany",
    "attributes":[{
      "name":"country_iso",
      "value":""
    },{
      "name":"sepa_credit_transfer",
      "value":"YES"
    },{
      "name":"sepa_direct_debit",
      "value":"YES"
    },{
      "name":"sepa_sdd_core",
      "value":"YES"
    },{
      "name":"sepa_b2b",
      "value":"YES"
    },{
      "name":"sepa_card_clearing",
      "value":"YES"
    }]
  }
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by ibanChecker, operation_id: OBPv4.0.0-ibanChecker Tags: Account,

Create (DAuth) User with Account Access

This endpoint is used as part of the DAuth solution to grant access to account and transaction data to a smart contract on the blockchain.

Put the smart contract address in username

For provider use "dauth"

This endpoint will create the (DAuth) User with username and provider if the User does not already exist.

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the logged in user needs to be account holder.

For information about DAuth see below:

DAuth

DAuth Introduction, Setup and Usage

DAuth is an experimental authentication mechanism that aims to pin an ethereum or other blockchain Smart Contract to an OBP "User".

In the future, it might be possible to be more specific and pin specific actors (wallets) that are acting within the smart contract, but so far, one smart contract acts on behalf of one User.

Thus, if a smart contract "X" calls the OBP API using the DAuth header, OBP will get or create a user called X and the call will proceed in the context of that User "X".

DAuth is invoked by the REST client (caller) including a specific header (see step 3 below) in any OBP REST call.

When OBP receives the DAuth token, it creates or gets a User with a username based on the smart_contract_address and the provider based on the network_name. The combination of username and provider is unique in OBP.

If you are calling OBP-API via an API3 Airnode, the Airnode will take care of constructing the required header.

When OBP detects a DAuth header / token it first checks if the Consumer is allowed to make such a call. OBP will validate the Consumer ip address and signature etc.

Note: The DAuth flow does not require an explicit POST like Direct Login to create the token.

Permissions may be assigned to an OBP User at any time, via the UserAuthContext, Views, Entitlements to Roles or Consents.

Note: DAuth is NOT enabled on this instance!

Note: The DAuth client is responsible for creating a token which will be trusted by OBP absolutely!

To use DAuth:

1) Configure OBP API to accept DAuth.

Set up properties in your props file

# -- DAuth --------------------------------------
# Define secret used to validate JWT token
# jwt.public_key_rsa=path-to-the-pem-file
# Enable/Disable DAuth communication at all
# In case isn't defined default value is false
# allow_dauth=false
# Define comma separated list of allowed IP addresses
# dauth.host=127.0.0.1
# -------------------------------------- DAuth--

Please keep in mind that property jwt.public_key_rsa is used to validate JWT token to check it is not changed or corrupted during transport.

2) Create / have access to a JWT

The following videos are available:
* DAuth in local environment

HEADER:ALGORITHM & TOKEN TYPE

{
  "alg": "RS256",
  "typ": "JWT"
}

PAYLOAD:DATA

{
  "smart_contract_address": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",
  "network_name": "AIRNODE.TESTNET.ETHEREUM",
  "msg_sender": "0xe12340927f1725E7734CE288F8367e1Bb143E90fhku767",
  "consumer_key": "0x1234a4ec31e89cea54d1f125db7536e874ab4a96b4d4f6438668b6bb10a6adb",
  "timestamp": "2021-11-04T14:13:40Z",
  "request_id": "0Xe876987694328763492876348928736497869273649"
}

VERIFY SIGNATURE

RSASHA256(
  base64UrlEncode(header) + "." +
  base64UrlEncode(payload),
) your-RSA-key-pair

Here is an example token:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k

3) Try a REST call using the header

Using your favorite http client:

Body

Leave Empty!

Headers:

   DAuth: your-jwt-from-step-above

Here is it all together:

GET https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current HTTP/1.1
Host: localhost:8080
User-Agent: curl/7.47.0
Accept: /
DAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k

CURL example

curl -v -H 'DAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k' https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current

You should receive a response like:

{
    "user_id": "4c4d3175-1e5c-4cfd-9b08-dcdc209d8221",
    "email": "",
    "provider_id": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",
    "provider": "ETHEREUM",
    "username": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",
    "entitlements": {
        "list": []
    }
}

Under the hood

The file, dauth.scala handles the DAuth,

We:

-> Check if Props allow_dauth is true
  -> Check if DAuth header exists
    -> Check if getRemoteIpAddress is OK
      -> Look for "token"
        -> parse the JWT token and getOrCreate the user
          -> get the data of the user

More information

Parameter names and values are case sensitive.
Each parameter MUST NOT appear more than once per request.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON request body fields:

is_system: true

provider: ETHEREUM

username: felixsmith

view_id: owner

views:

JSON response body fields:

can_add_counterparty: false

can_add_transaction_request_to_any_account:

can_add_tag: false

can_add_transaction_request_to_own_account: false

can_create_standing_order:

can_create_direct_debit: false

can_query_available_funds: false

can_see_bank_account_credit_limit: false

can_see_bank_account_routing_address:

can_see_bank_account_routing_scheme:

can_see_bank_routing_scheme:

can_see_bank_routing_address: false

can_see_other_account_national_identifier: false

can_see_other_account_routing_scheme:

can_see_other_account_routing_address: false

can_see_other_bank_routing_address:

can_see_other_bank_routing_scheme:

can_see_url: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

is_system: true

metadata_view:

is_firehose:

Typical Successful Response:

								
									[{
  "id":"1234",
  "short_name":"short_name",
  "description":"description",
  "metadata_view":"owner",
  "is_public":true,
  "is_system":true,
  "alias":"No",
  "hide_metadata_if_alias_used":true,
  "can_add_comment":true,
  "can_add_corporate_location":true,
  "can_add_image":true,
  "can_add_image_url":true,
  "can_add_more_info":true,
  "can_add_open_corporates_url":true,
  "can_add_physical_location":true,
  "can_add_private_alias":true,
  "can_add_public_alias":true,
  "can_add_tag":true,
  "can_add_url":true,
  "can_add_where_tag":true,
  "can_delete_comment":true,
  "can_add_counterparty":true,
  "can_delete_corporate_location":true,
  "can_delete_image":true,
  "can_delete_physical_location":true,
  "can_delete_tag":true,
  "can_delete_where_tag":true,
  "can_edit_owner_comment":true,
  "can_see_bank_account_balance":true,
  "can_query_available_funds":true,
  "can_see_bank_account_bank_name":true,
  "can_see_bank_account_currency":true,
  "can_see_bank_account_iban":true,
  "can_see_bank_account_label":true,
  "can_see_bank_account_national_identifier":true,
  "can_see_bank_account_number":true,
  "can_see_bank_account_owners":true,
  "can_see_bank_account_swift_bic":true,
  "can_see_bank_account_type":true,
  "can_see_comments":true,
  "can_see_corporate_location":true,
  "can_see_image_url":true,
  "can_see_images":true,
  "can_see_more_info":true,
  "can_see_open_corporates_url":true,
  "can_see_other_account_bank_name":true,
  "can_see_other_account_iban":true,
  "can_see_other_account_kind":true,
  "can_see_other_account_metadata":true,
  "can_see_other_account_national_identifier":true,
  "can_see_other_account_number":true,
  "can_see_other_account_swift_bic":true,
  "can_see_owner_comment":true,
  "can_see_physical_location":true,
  "can_see_private_alias":true,
  "can_see_public_alias":true,
  "can_see_tags":true,
  "can_see_transaction_amount":true,
  "can_see_transaction_balance":true,
  "can_see_transaction_currency":true,
  "can_see_transaction_description":true,
  "can_see_transaction_finish_date":true,
  "can_see_transaction_metadata":true,
  "can_see_transaction_other_bank_account":true,
  "can_see_transaction_start_date":true,
  "can_see_transaction_this_bank_account":true,
  "can_see_transaction_type":true,
  "can_see_url":true,
  "can_see_where_tag":true,
  "can_see_bank_routing_scheme":true,
  "can_see_bank_routing_address":true,
  "can_see_bank_account_routing_scheme":true,
  "can_see_bank_account_routing_address":true,
  "can_see_other_bank_routing_scheme":true,
  "can_see_other_bank_routing_address":true,
  "can_see_other_account_routing_scheme":true,
  "can_see_other_account_routing_address":true,
  "can_add_transaction_request_to_own_account":true,
  "can_add_transaction_request_to_any_account":true,
  "can_see_bank_account_credit_limit":true,
  "can_create_direct_debit":true,
  "can_create_standing_order":true
}]

Request Headers:

Response Headers:

Required Roles:

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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-20084: The current source view.can_grant_access_to_views does not contains target view.
OBP-20085: The current source view.can_grant_access_to_custom_views is false.
OBP-10001: Incorrect json format.
OBP-30252: System view not found. Please specify a valid value for VIEW_ID
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-30063: Cannot grant account access.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv5.1.0, function_name: by createUserWithAccountAccessById, operation_id: OBPv5.1.0-createUserWithAccountAccessById Tags: Account-Access, View-Custom, Account, User, OwnerViewRequired, DAuth,

Grant User access to View

Grants the User identified by USER_ID access to the view identified.

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to be account holder.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON request body fields:

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

view_id: owner

JSON response body fields:

can_add_counterparty: false

can_add_transaction_request_to_any_account:

can_add_tag: false

can_add_transaction_request_to_own_account: false

can_create_standing_order:

can_create_direct_debit: false

can_query_available_funds: false

can_see_bank_account_credit_limit: false

can_see_bank_account_routing_address:

can_see_bank_account_routing_scheme:

can_see_bank_routing_scheme:

can_see_bank_routing_address: false

can_see_other_account_national_identifier: false

can_see_other_account_routing_scheme:

can_see_other_account_routing_address: false

can_see_other_bank_routing_address:

can_see_other_bank_routing_scheme:

can_see_url: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

is_system: true

metadata_view:

is_firehose:

Typical Successful Response:

								
									{
  "id":"1234",
  "short_name":"short_name",
  "description":"description",
  "metadata_view":"owner",
  "is_public":true,
  "is_system":true,
  "alias":"No",
  "hide_metadata_if_alias_used":true,
  "can_add_comment":true,
  "can_add_corporate_location":true,
  "can_add_image":true,
  "can_add_image_url":true,
  "can_add_more_info":true,
  "can_add_open_corporates_url":true,
  "can_add_physical_location":true,
  "can_add_private_alias":true,
  "can_add_public_alias":true,
  "can_add_tag":true,
  "can_add_url":true,
  "can_add_where_tag":true,
  "can_delete_comment":true,
  "can_add_counterparty":true,
  "can_delete_corporate_location":true,
  "can_delete_image":true,
  "can_delete_physical_location":true,
  "can_delete_tag":true,
  "can_delete_where_tag":true,
  "can_edit_owner_comment":true,
  "can_see_bank_account_balance":true,
  "can_query_available_funds":true,
  "can_see_bank_account_bank_name":true,
  "can_see_bank_account_currency":true,
  "can_see_bank_account_iban":true,
  "can_see_bank_account_label":true,
  "can_see_bank_account_national_identifier":true,
  "can_see_bank_account_number":true,
  "can_see_bank_account_owners":true,
  "can_see_bank_account_swift_bic":true,
  "can_see_bank_account_type":true,
  "can_see_comments":true,
  "can_see_corporate_location":true,
  "can_see_image_url":true,
  "can_see_images":true,
  "can_see_more_info":true,
  "can_see_open_corporates_url":true,
  "can_see_other_account_bank_name":true,
  "can_see_other_account_iban":true,
  "can_see_other_account_kind":true,
  "can_see_other_account_metadata":true,
  "can_see_other_account_national_identifier":true,
  "can_see_other_account_number":true,
  "can_see_other_account_swift_bic":true,
  "can_see_owner_comment":true,
  "can_see_physical_location":true,
  "can_see_private_alias":true,
  "can_see_public_alias":true,
  "can_see_tags":true,
  "can_see_transaction_amount":true,
  "can_see_transaction_balance":true,
  "can_see_transaction_currency":true,
  "can_see_transaction_description":true,
  "can_see_transaction_finish_date":true,
  "can_see_transaction_metadata":true,
  "can_see_transaction_other_bank_account":true,
  "can_see_transaction_start_date":true,
  "can_see_transaction_this_bank_account":true,
  "can_see_transaction_type":true,
  "can_see_url":true,
  "can_see_where_tag":true,
  "can_see_bank_routing_scheme":true,
  "can_see_bank_routing_address":true,
  "can_see_bank_account_routing_scheme":true,
  "can_see_bank_account_routing_address":true,
  "can_see_other_bank_routing_scheme":true,
  "can_see_other_bank_routing_address":true,
  "can_see_other_account_routing_scheme":true,
  "can_see_other_account_routing_address":true,
  "can_add_transaction_request_to_own_account":true,
  "can_add_transaction_request_to_any_account":true,
  "can_see_bank_account_credit_limit":true,
  "can_create_direct_debit":true,
  "can_create_standing_order":true
}

Request Headers:

Response Headers:

Required Roles:

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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-20084: The current source view.can_grant_access_to_views does not contains target view.
OBP-20085: The current source view.can_grant_access_to_custom_views is false.
OBP-10001: Incorrect json format.
OBP-20005: User not found. Please specify a valid value for USER_ID.
OBP-30252: System view not found. Please specify a valid value for VIEW_ID
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-30063: Cannot grant account access.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv5.1.0, function_name: by grantUserAccessToViewById, operation_id: OBPv5.1.0-grantUserAccessToViewById Tags: Account-Access, View-Custom, Account, User, OwnerViewRequired,

Revoke User access to View

Revoke the User identified by USER_ID access to the view identified.

User Authentication is Required. The User must be logged in. The Application must also be authenticated..

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON request body fields:

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

view_id: owner

JSON response body fields:

revoked:

Typical Successful Response:

								
									{
  "revoked":true
}

Request Headers:

Response Headers:

Required Roles:

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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-20087: The current source view.can_revoke_access_to_custom_views is false.
OBP-20086: The current source view.can_revoke_access_to_views does not contains target view.
OBP-10001: Incorrect json format.
OBP-20005: User not found. Please specify a valid value for USER_ID.
OBP-30252: System view not found. Please specify a valid value for VIEW_ID
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-30064: Cannot revoke account access.
OBP-30065: Cannot find account access.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv5.1.0, function_name: by revokeUserAccessToViewById, operation_id: OBPv5.1.0-revokeUserAccessToViewById Tags: Account-Access, View-Custom, Account, User, OwnerViewRequired,

Create Account Application

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

product_code: 1234BW

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

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

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

branch_id: DERBY6

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

customer_number: 5987953

date: 2020-01-27

date_of_application: 2020-01-27

date_of_birth: 2018-03-09

dob_of_dependants: [2019-09-08, 2017-07-12]

kyc_status: false

last_ok_date: 2024-03-17T21:00:28.529Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

product_code: 1234BW

provider: ETHEREUM

url: http://www.example.com/id-docs/123/image.png

title: Dr.

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

username: felixsmith

Typical Successful Response:

								
									{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"1234BW",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "customer":{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"1100-01-01T00:00:00Z"
    },
    "date_of_birth":"1100-01-01T00:00:00Z",
    "relationship_status":"single",
    "dependants":1,
    "dob_of_dependants":["1100-01-01T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"0"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":false,
    "last_ok_date":"2024-03-17T21:00:29Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "date_of_application":"1100-01-01T00:00:00Z",
  "status":"REQUESTED"
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-10001: Incorrect json format.
OBP-50000: Unknown Error.
OBP-20001: User not logged in. Authentication is required!

Connector Methods:

Version: OBPv3.1.0, function_name: by createAccountApplication, operation_id: OBPv3.1.0-createAccountApplication Tags: Account-Application, Account,

Get Account Application by Id

Get the Account Application.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_APPLICATION_ID:

BANK_ID: gh.29.uk

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

branch_id: DERBY6

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

customer_number: 5987953

date: 2020-01-27

date_of_application: 2020-01-27

date_of_birth: 2018-03-09

dob_of_dependants: [2019-09-08, 2017-07-12]

kyc_status: false

last_ok_date: 2024-03-17T21:00:28.529Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

product_code: 1234BW

provider: ETHEREUM

url: http://www.example.com/id-docs/123/image.png

title: Dr.

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

username: felixsmith

Typical Successful Response:

								
									{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"1234BW",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "customer":{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"1100-01-01T00:00:00Z"
    },
    "date_of_birth":"1100-01-01T00:00:00Z",
    "relationship_status":"single",
    "dependants":1,
    "dob_of_dependants":["1100-01-01T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"0"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":false,
    "last_ok_date":"2024-03-17T21:00:29Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "date_of_application":"1100-01-01T00:00:00Z",
  "status":"REQUESTED"
}

Request Headers:

Response Headers:

Required Roles:

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: OBPv3.1.0, function_name: by getAccountApplication, operation_id: OBPv3.1.0-getAccountApplication Tags: Account-Application, Account,

Get Account Applications

Get the Account Applications.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

account_applications:

amount: 10.12

bank_id: gh.29.uk

branch_id: DERBY6

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

customer_number: 5987953

date: 2020-01-27

date_of_application: 2020-01-27

date_of_birth: 2018-03-09

dob_of_dependants: [2019-09-08, 2017-07-12]

kyc_status: false

last_ok_date: 2024-03-17T21:00:28.529Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

product_code: 1234BW

provider: ETHEREUM

url: http://www.example.com/id-docs/123/image.png

title: Dr.

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

username: felixsmith

Typical Successful Response:

								
									{
  "account_applications":[{
    "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
    "product_code":"1234BW",
    "user":{
      "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "email":"felixsmith@example.com",
      "provider_id":"Chris",
      "provider":"http://127.0.0.1:8080",
      "username":"felixsmith"
    },
    "customer":{
      "bank_id":"gh.29.uk",
      "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customer_number":"5987953",
      "legal_name":"Eveline Tripman",
      "mobile_phone_number":"+44 07972 444 876",
      "email":"felixsmith@example.com",
      "face_image":{
        "url":"www.openbankproject",
        "date":"1100-01-01T00:00:00Z"
      },
      "date_of_birth":"1100-01-01T00:00:00Z",
      "relationship_status":"single",
      "dependants":1,
      "dob_of_dependants":["1100-01-01T00:00:00Z"],
      "credit_rating":{
        "rating":"OBP",
        "source":"OBP"
      },
      "credit_limit":{
        "currency":"EUR",
        "amount":"0"
      },
      "highest_education_attained":"Master",
      "employment_status":"worker",
      "kyc_status":false,
      "last_ok_date":"2024-03-17T21:00:29Z",
      "title":"Dr.",
      "branch_id":"DERBY6",
      "name_suffix":"Sr"
    },
    "date_of_application":"1100-01-01T00:00:00Z",
    "status":"REQUESTED"
  }]
}

Request Headers:

Response Headers:

Required Roles:

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: OBPv3.1.0, function_name: by getAccountApplications, operation_id: OBPv3.1.0-getAccountApplications Tags: Account-Application, Account,

Update Account Application Status

Update an Account Application status

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_APPLICATION_ID:

BANK_ID: gh.29.uk

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

branch_id: DERBY6

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

customer_number: 5987953

date: 2020-01-27

date_of_application: 2020-01-27

date_of_birth: 2018-03-09

dob_of_dependants: [2019-09-08, 2017-07-12]

kyc_status: false

last_ok_date: 2024-03-17T21:00:28.529Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

product_code: 1234BW

provider: ETHEREUM

url: http://www.example.com/id-docs/123/image.png

title: Dr.

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

username: felixsmith

Typical Successful Response:

								
									{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"1234BW",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "customer":{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"1100-01-01T00:00:00Z"
    },
    "date_of_birth":"1100-01-01T00:00:00Z",
    "relationship_status":"single",
    "dependants":1,
    "dob_of_dependants":["1100-01-01T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"0"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":false,
    "last_ok_date":"2024-03-17T21:00:29Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "date_of_application":"1100-01-01T00:00:00Z",
  "status":"REQUESTED"
}

Request Headers:

Response Headers:

Required Roles:

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: OBPv3.1.0, function_name: by updateAccountApplicationStatus, operation_id: OBPv3.1.0-updateAccountApplicationStatus Tags: Account-Application, Account,

Create a tag on account

Posts a tag about an account ACCOUNT_ID on a view VIEW_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Authentication is required as the tag is linked with the user.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON request body fields:

value: 5987953

JSON response body fields:

date: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

provider: ETHEREUM

value: 5987953

Typical Successful Response:

								
									{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "value":"OBP",
  "date":"1100-01-01T00:00:00Z",
  "user":{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }
}

Request Headers:

Response Headers:

Required Roles:

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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-10001: Incorrect json format.
OBP-30022: The current view does not have the permission:
OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by addTagForViewOnAccount, operation_id: OBPv4.0.0-addTagForViewOnAccount Tags: Account-Metadata, Account,

Delete a tag on account

Deletes the tag TAG_ID about the account ACCOUNT_ID made on view.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Authentication is required as the tag is linked with the user.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TAG_ID:

VIEW_ID: owner

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by deleteTagForViewOnAccount, operation_id: OBPv4.0.0-deleteTagForViewOnAccount Tags: Account-Metadata, Account,

Get tags on account

Returns the account ACCOUNT_ID tags made on a view (VIEW_ID).
User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Authentication is required as the tag is linked with the user.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

date: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

provider: ETHEREUM

tags: Create-My-User

value: 5987953

Typical Successful Response:

								
									{
  "tags":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "value":"OBP",
    "date":"1100-01-01T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }
  }]
}

Request Headers:

Response Headers:

Required Roles:

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-30022: The current view does not have the permission:
OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getTagsForViewOnAccount, operation_id: OBPv4.0.0-getTagsForViewOnAccount Tags: Account-Metadata, Account,

Get Public Account by Id

Returns information about an account that has a public view.

The account is specified by ACCOUNT_ID. The information is moderated by the view specified by VIEW_ID.

Number
Owners
Type
Balance
Routing

PSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
This call provides balance and other account information via delegated authentication using OAuth.

User Authentication is Optional. The User need not be logged in.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

account_rules:

amount: 10.12

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

provider: ETHEREUM

scheme: OBP

value: 5987953

account_attributes:

product_instance_code: product_instance_code

Typical Successful Response:

								
									{
  "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "bank_id":"gh.29.uk",
  "label":"My Account",
  "number":"",
  "owners":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }],
  "type":"",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "account_routings":[{
    "scheme":"OBP",
    "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  }],
  "account_rules":[{
    "scheme":"OVERDRAFT",
    "value":"10"
  }],
  "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",
    "product_instance_code":"LKJL98769F"
  }]
}

Request Headers:

Response Headers:

Required Roles:

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-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.0.0, function_name: by getPublicAccountById, operation_id: OBPv3.0.0-getPublicAccountById Tags: Account-Public, Account,

Get Public Accounts at Bank

Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "label":"NoneLabel",
    "bank_id":"gh.29.uk",
    "views_available":[{
      "id":"1",
      "short_name":"HHH",
      "is_public":true
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv2.0.0, function_name: by publicAccountsAtOneBank, operation_id: OBPv2.0.0-publicAccountsAtOneBank Tags: Account-Public, Account, PublicData,

Get Public Accounts at all Banks

Get public accounts at all banks (Anonymous access).
Returns accounts that contain at least one public view (a view where is_public is true)
For each account the API returns the ID and the available views.

User Authentication is Optional. The User need not be logged in.

JSON response body fields:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "label":"NoneLabel",
    "bank_id":"gh.29.uk",
    "views_available":[{
      "id":"1",
      "short_name":"HHH",
      "is_public":true
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-30066: Could not get accounts.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv2.0.0, function_name: by publicAccountsAllBanks, operation_id: OBPv2.0.0-publicAccountsAllBanks Tags: Account-Public, Account, PublicData,

Create My Api Collection

Create Api Collection for logged in user.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

api_collection_name: Favourites

is_sharable: is_sharable

description: Description of the object. 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: Description of the object. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Typical Successful Response:

								
									{
  "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "api_collection_name":"Favourites",
  "is_sharable":true,
  "description":"Description of the object. Maximum length is 2000. It can be any characters here."
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-10001: Incorrect json format.
OBP-20057: User not found by userId.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by createMyApiCollection, operation_id: OBPv4.0.0-createMyApiCollection Tags: Api-Collection,

Create My Api Collection Endpoint

Create Api Collection Endpoint.

glossary-item-not-found

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

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

Typical Successful Response:

								
									{
  "api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "operation_id":"OBPv4.0.0-getBanks"
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-10001: Incorrect json format.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by createMyApiCollectionEndpoint, operation_id: OBPv4.0.0-createMyApiCollectionEndpoint Tags: Api-Collection,

Create My Api Collection Endpoint By Id

Create Api Collection Endpoint By Id.

glossary-item-not-found

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

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

Typical Successful Response:

								
									{
  "api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "operation_id":"OBPv4.0.0-getBanks"
}

Request Headers:

Response Headers:

Required Roles:

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 createMyApiCollectionEndpointById, operation_id: OBPv4.0.0-createMyApiCollectionEndpointById Tags: Api-Collection,

Delete My Api Collection

Delete Api Collection By API_COLLECTION_ID

glossary-item-not-found

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

JSON response body fields:

Typical Successful Response:

								
									true

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20057: User not found by userId.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by deleteMyApiCollection, operation_id: OBPv4.0.0-deleteMyApiCollection Tags: Api-Collection,

Delete My Api Collection Endpoint

glossary-item-not-found

Delete Api Collection Endpoint By OPERATION_ID

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

API_COLLECTION_NAME: Favourites

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

Typical Successful Response:

								
									true

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20057: User not found by userId.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by deleteMyApiCollectionEndpoint, operation_id: OBPv4.0.0-deleteMyApiCollectionEndpoint Tags: Api-Collection,

Delete My Api Collection Endpoint By Id

glossary-item-not-found

Delete Api Collection Endpoint By OPERATION_ID

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

Typical Successful Response:

								
									true

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20057: User not found by userId.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by deleteMyApiCollectionEndpointByOperationId, operation_id: OBPv4.0.0-deleteMyApiCollectionEndpointByOperationId Tags: Api-Collection,

Delete My Api Collection Endpoint By Id

glossary-item-not-found
Delete Api Collection Endpoint
Delete Api Collection Endpoint By Id

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

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

JSON response body fields:

Typical Successful Response:

								
									true

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20057: User not found by userId.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by deleteMyApiCollectionEndpointById, operation_id: OBPv4.0.0-deleteMyApiCollectionEndpointById Tags: Api-Collection,

Get All API Collections

Get All API Collections.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

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

api_collection_name: Favourites

api_collections: api_collections

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Typical Successful Response:

								
									{
  "api_collections":[{
    "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "api_collection_name":"Favourites",
    "is_sharable":true,
    "description":"Description of the object. Maximum length is 2000. It can be any characters here."
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetAllApiCollections - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.
OBP-20001: User not logged in. Authentication is required!

Connector Methods:

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.

User Authentication is Optional. The User need not be logged in.

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

Typical Successful Response:

								
									{
  "api_collection_endpoints":[{
    "api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "operation_id":"OBPv4.0.0-getBanks"
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getApiCollectionEndpoints, operation_id: OBPv4.0.0-getApiCollectionEndpoints Tags: Api-Collection,

Get Api Collections for User

Get Api Collections for User.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

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: Description of the object. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Typical Successful Response:

								
									{
  "api_collections":[{
    "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "api_collection_name":"Favourites",
    "is_sharable":true,
    "description":"Description of the object. Maximum length is 2000. It can be any characters here."
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetApiCollectionsForUser - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20057: User not found by userId.
OBP-50000: Unknown Error.
OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv4.0.0, function_name: by getApiCollectionsForUser, operation_id: OBPv4.0.0-getApiCollectionsForUser Tags: Api-Collection,

Get Featured Api Collections

Get Featured Api Collections.

User Authentication is Optional. The User need not be logged in.

JSON response body fields:

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

api_collection_name: Favourites

api_collections: api_collections

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Typical Successful Response:

								
									{
  "api_collections":[{
    "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "api_collection_name":"Favourites",
    "is_sharable":true,
    "description":"Description of the object. Maximum length is 2000. It can be any characters here."
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getFeaturedApiCollections, operation_id: OBPv4.0.0-getFeaturedApiCollections Tags: Api-Collection,

Get My Api Collection By Id

Get Api Collection By API_COLLECTION_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

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: Description of the object. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Typical Successful Response:

								
									{
  "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "api_collection_name":"Favourites",
  "is_sharable":true,
  "description":"Description of the object. Maximum length is 2000. It can be any characters here."
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20057: User not found by userId.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getMyApiCollectionById, operation_id: OBPv4.0.0-getMyApiCollectionById Tags: Api-Collection,

Get My Api Collection By Name

Get Api Collection By API_COLLECTION_NAME.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

API_COLLECTION_NAME: Favourites

JSON response body fields:

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

api_collection_name: Favourites

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Typical Successful Response:

								
									{
  "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "api_collection_name":"Favourites",
  "is_sharable":true,
  "description":"Description of the object. Maximum length is 2000. It can be any characters here."
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20057: User not found by userId.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getMyApiCollectionByName, operation_id: OBPv4.0.0-getMyApiCollectionByName Tags: Api-Collection,

Get My Api Collection Endpoint

Get Api Collection Endpoint By API_COLLECTION_NAME and OPERATION_ID.

User Authentication is Optional. The User need not be logged in.

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

Typical Successful Response:

								
									{
  "api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "operation_id":"OBPv4.0.0-getBanks"
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20057: User not found by userId.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getMyApiCollectionEndpoint, operation_id: OBPv4.0.0-getMyApiCollectionEndpoint Tags: Api-Collection,

Get My Api Collection Endpoints

Get Api Collection Endpoints By API_COLLECTION_NAME.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

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

Typical Successful Response:

								
									{
  "api_collection_endpoints":[{
    "api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "operation_id":"OBPv4.0.0-getBanks"
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20057: User not found by userId.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getMyApiCollectionEndpoints, operation_id: OBPv4.0.0-getMyApiCollectionEndpoints Tags: Api-Collection,

Get My Api Collection Endpoints By Id

Get Api Collection Endpoints By API_COLLECTION_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

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

Typical Successful Response:

								
									{
  "api_collection_endpoints":[{
    "api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "operation_id":"OBPv4.0.0-getBanks"
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20057: User not found by userId.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getMyApiCollectionEndpointsById, operation_id: OBPv4.0.0-getMyApiCollectionEndpointsById Tags: Api-Collection,

Get My Api Collections

Get all the apiCollections for logged in user.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

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

api_collection_name: Favourites

api_collections: api_collections

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Typical Successful Response:

								
									{
  "api_collections":[{
    "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "api_collection_name":"Favourites",
    "is_sharable":true,
    "description":"Description of the object. Maximum length is 2000. It can be any characters here."
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getMyApiCollections, operation_id: OBPv4.0.0-getMyApiCollections Tags: Api-Collection,

Get Sharable Api Collection By Id

Get Sharable Api Collection By Id.
User Authentication is Optional. The User need not be logged in.

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: Description of the object. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Typical Successful Response:

								
									{
  "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "api_collection_name":"Favourites",
  "is_sharable":true,
  "description":"Description of the object. Maximum length is 2000. It can be any characters here."
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getSharableApiCollectionById, operation_id: OBPv4.0.0-getSharableApiCollectionById Tags: Api-Collection,

Update My Api Collection By API_COLLECTION_ID

Update Api Collection for logged in user.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

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: Description of the object. Maximum length is 2000. It can be any characters here.

is_sharable: is_sharable

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

Typical Successful Response:

								
									{
  "api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "api_collection_name":"Favourites",
  "is_sharable":true,
  "description":"Description of the object. Maximum length is 2000. It can be any characters here."
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-10001: Incorrect json format.
OBP-20057: User not found by userId.
OBP-50000: Unknown Error.

Connector Methods:

Version: 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.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									{
  "operation_id":"OBPv4.0.0-updateXxx",
  "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"]
}

Request Headers:

Response Headers:

Required Roles:

CanCreateAuthenticationTypeValidation - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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

Connector Methods:

Version: OBPv4.0.0, function_name: by createAuthenticationTypeValidation, operation_id: OBPv4.0.0-createAuthenticationTypeValidation Tags: Authentication-Type-Validation,

Delete an Authentication Type Validation

Delete an Authentication Type Validation by operation_id.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

Typical Successful Response:

								
									true

Request Headers:

Response Headers:

Required Roles:

CanDeleteAuthenticationValidation - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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

Connector Methods:

Version: OBPv4.0.0, function_name: by deleteAuthenticationTypeValidation, operation_id: OBPv4.0.0-deleteAuthenticationTypeValidation Tags: Authentication-Type-Validation,

Get all Authentication Type Validations

Get all Authentication Type Validations.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

Typical Successful Response:

								
									{
  "authentication_types_validations":[{
    "operation_id":"OBPv4.0.0-updateXxx",
    "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"]
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetAuthenticationTypeValidation - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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

Connector Methods:

Version: OBPv4.0.0, function_name: by getAllAuthenticationTypeValidations, operation_id: OBPv4.0.0-getAllAuthenticationTypeValidations Tags: Authentication-Type-Validation,

Get all Authentication Type Validations - public

Get all Authentication Type Validations - public.

User Authentication is Optional. The User need not be logged in.

JSON response body fields:

Typical Successful Response:

								
									{
  "authentication_types_validations":[{
    "operation_id":"OBPv4.0.0-updateXxx",
    "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"]
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-10001: Incorrect json format.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getAllAuthenticationTypeValidationsPublic, operation_id: OBPv4.0.0-getAllAuthenticationTypeValidationsPublic Tags: Authentication-Type-Validation,

Get an Authentication Type Validation

Get an Authentication Type Validation by operation_id.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

Typical Successful Response:

								
									{
  "operation_id":"OBPv4.0.0-updateXxx",
  "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"]
}

Request Headers:

Response Headers:

Required Roles:

CanGetAuthenticationTypeValidation - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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

Connector Methods:

Version: OBPv4.0.0, function_name: by getAuthenticationTypeValidation, operation_id: OBPv4.0.0-getAuthenticationTypeValidation Tags: Authentication-Type-Validation,

Update an Authentication Type Validation

Update an Authentication Type Validation.

Please supply allowed authentication types.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

OPERATION_ID: OBPv4.0.0-getBanks

JSON response body fields:

Typical Successful Response:

								
									{
  "operation_id":"OBPv4.0.0-updateXxx",
  "allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"]
}

Request Headers:

Response Headers:

Required Roles:

CanUpdateAuthenticationTypeValidation - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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

Connector Methods:

Version: OBPv4.0.0, function_name: by updateAuthenticationTypeValidation, operation_id: OBPv4.0.0-updateAuthenticationTypeValidation Tags: Authentication-Type-Validation,

Create Bank

Create a new bank (Authenticated access).

The user creating this will be automatically assigned the Role CanCreateEntitlementAtOneBank.
Thus the User can manage the bank they create and assign Roles to other Users.

Only SANDBOX mode
The settlement accounts are created specified by the bank in the POST body.
Name and account id are created in accordance to the next rules:
- Incoming account (name: Default incoming settlement account, Account ID: OBP_DEFAULT_INCOMING_ACCOUNT_ID, currency: EUR)
- Outgoing account (name: Default outgoing settlement account, Account ID: OBP_DEFAULT_OUTGOING_ACCOUNT_ID, currency: EUR)

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

website: www.openbankproject.com

bank_code: CGHZ

scheme: OBP

bank_routings: bank routing in form of (scheme, address)

full_name: full name string

id: d8839721-ad8f-45dd-9f78-2080414b93f9

logo: logo url

JSON response body fields:

bank_code: CGHZ

bank_routings: bank routing in form of (scheme, address)

full_name: full name string

id: d8839721-ad8f-45dd-9f78-2080414b93f9

logo: logo url

name: ACCOUNT_MANAGEMENT_FEE

scheme: OBP

value: 5987953

attributes: attribute value in form of (name, value)

Typical Successful Response:

								
									{
  "id":"gh.29.uk",
  "bank_code":"CGHZ",
  "full_name":"bank fullName string",
  "logo":"bank logoUrl string",
  "website":"bank logoUrl string",
  "bank_routings":[{
    "scheme":"OBP",
    "address":"gh.29.uk"
  }],
  "attributes":[{
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "value":"5987953"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanCreateBank - 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-30210: Insufficient authorisation to Create Bank. You do not have the role CanCreateBank.
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv5.0.0, function_name: by createBank, operation_id: OBPv5.0.0-createBank Tags: Bank,

Create Bank Attribute

Typical product 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"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

is_active: false

JSON response body fields:

bank_attribute_id: bank_attribute_id

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

is_active: false

Typical Successful Response:

								
									{
  "bank_id":"gh.29.uk",
  "bank_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "name":"OVERDRAFT_START_DATE",
  "type":"DATE_WITH_DAY",
  "value":"2012-04-23",
  "is_active":true
}

Request Headers:

Response Headers:

Required Roles:

CanCreateBankAttribute - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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

Connector Methods:

Version: OBPv4.0.0, function_name: by createBankAttribute, operation_id: OBPv4.0.0-createBankAttribute Tags: Bank,

Create Settlement Account

Create a new settlement account at a bank.

The created settlement account id will be the concatenation of the payment system and the account currency.
For examples: SEPA_SETTLEMENT_ACCOUNT_EUR, CARD_SETTLEMENT_ACCOUNT_USD

By default, when you create a new bank, two settlements accounts are created automatically: OBP_DEFAULT_INCOMING_ACCOUNT_ID and OBP_DEFAULT_OUTGOING_ACCOUNT_ID
Those two accounts have EUR as default currency.

If you want to create default settlement account for a specific currency, you can fill the payment_system field with the DEFAULT value.

When a transaction is saved in OBP through the mapped connector, OBP-API look for the account to save the double-entry transaction.
If no OBP account can be found from the counterparty, the double-entry transaction will be saved on a bank settlement account.
- First, the mapped connector looks for a settlement account specific to the payment system and currency. E.g SEPA_SETTLEMENT_ACCOUNT_EUR.
- If we don't find any specific settlement account with the payment system, we look for a default settlement account for the counterparty currency. E.g DEFAULT_SETTLEMENT_ACCOUNT_EUR.
- Else, we select one of the two OBP default settlement accounts (OBP_DEFAULT_INCOMING_ACCOUNT_ID/OBP_DEFAULT_OUTGOING_ACCOUNT_ID) according to the transaction direction.

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.

Note: The Amount MUST be zero.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

amount: 10.12

branch_id: DERBY6

label: My Account

payment_system: SEPA

scheme: OBP

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

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

amount: 10.12

branch_id: DERBY6

label: My Account

name: ACCOUNT_MANAGEMENT_FEE

payment_system: SEPA

product_code: 1234BW

scheme: OBP

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

value: 5987953

product_instance_code: product_instance_code

Typical Successful Response:

								
									{
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "payment_system":"SEPA",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "label":"My Account",
  "branch_id":"DERBY6",
  "account_routings":[{
    "scheme":"OBP",
    "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  }],
  "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",
    "product_instance_code":"LKJL98769F"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanCreateSettlementAccountAtOneBank - 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-30001: Bank not found. Please specify a valid value for BANK_ID.
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-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by createSettlementAccount, operation_id: OBPv4.0.0-createSettlementAccount Tags: Bank,

Create Transaction Type at bank

Create Transaction Types for the bank specified by BANK_ID:

id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.
bank_id : The bank that supports this TransactionType
short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here
summary : A succinct summary
description : A longer description
charge : The charge to the customer for each one of these

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

amount: 10.12

bankId:

charge:

description: Description of the object. Maximum length is 2000. It can be any characters here.

id: d8839721-ad8f-45dd-9f78-2080414b93f9

shortCode:

summary:

value: 5987953

Typical Successful Response:

								
									{
  "id":{
    "value":"123"
  },
  "bankId":{
    "value":"gh.uk.9j"
  },
  "shortCode":"80080",
  "summary":"SANDBOX_TAN",
  "description":"This is the sandbox mode, charging litter money.",
  "charge":{
    "currency":"EUR",
    "amount":"100"
  }
}

Request Headers:

Response Headers:

Required Roles:

CanCreateTransactionType - 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-40005: Insufficient authorisation to Create Transaction Type offered by the bank. The Request could not be created because you don't have access to CanCreateTransactionType.
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv2.1.0, function_name: by createTransactionType, operation_id: OBPv2.1.0-createTransactionType Tags: Bank,

Create or Update Bank Attribute Definition

The category field must be Bank

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_id: gh.29.uk

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_active: false

name: ACCOUNT_MANAGEMENT_FEE

Typical Successful Response:

								
									{
  "attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "bank_id":"gh.29.uk",
  "name":"SPECIAL_TAX_NUMBER",
  "category":"Bank",
  "type":"STRING",
  "description":"description",
  "alias":"STRING",
  "can_be_seen_on_views":["bank"],
  "is_active":true
}

Request Headers:

Response Headers:

Required Roles:

CanCreateBankAttributeDefinitionAtOneBank - 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 createOrUpdateBankAttributeDefinition, operation_id: OBPv4.0.0-createOrUpdateBankAttributeDefinition Tags: Bank,

Delete Bank Attribute

Delete a Bank Attribute by its id.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ATTRIBUTE_ID: BANK_ATTRIBUTE_ID

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

Required Roles:

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.
OBP-20001: User not logged in. Authentication is required!

Connector Methods:

Version: OBPv4.0.0, function_name: by deleteBankAttribute, operation_id: OBPv4.0.0-deleteBankAttribute Tags: Bank,

Delete Bank Cascade

Delete a Bank Cascade specified by BANK_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

Required Roles:

CanDeleteBankCascade - 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 deleteBankCascade, operation_id: OBPv4.0.0-deleteBankCascade Tags: Bank,

Get Bank

Get the bank specified by BANK_ID
Returns information about a single bank specified by BANK_ID including:

Bank code and full name of bank
Logo URL
Website

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_code: CGHZ

bank_routings: bank routing in form of (scheme, address)

full_name: full name string

id: d8839721-ad8f-45dd-9f78-2080414b93f9

logo: logo url

name: ACCOUNT_MANAGEMENT_FEE

scheme: OBP

value: 5987953

attributes: attribute value in form of (name, value)

Typical Successful Response:

								
									{
  "id":"gh.29.uk",
  "bank_code":"CGHZ",
  "full_name":"bank fullName string",
  "logo":"bank logoUrl string",
  "website":"bank logoUrl string",
  "bank_routings":[{
    "scheme":"OBP",
    "address":"gh.29.uk"
  }],
  "attributes":[{
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "value":"5987953"
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.

Connector Methods:

Version: OBPv5.0.0, function_name: by getBank, operation_id: OBPv5.0.0-getBank Tags: Bank, Account Information Service (AIS), PSD2,

Get Bank Attribute By BANK_ATTRIBUTE_ID

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ATTRIBUTE_ID: BANK_ATTRIBUTE_ID

BANK_ID: gh.29.uk

JSON response body fields:

bank_attribute_id: bank_attribute_id

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

is_active: false

Typical Successful Response:

								
									{
  "bank_id":"gh.29.uk",
  "bank_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "name":"OVERDRAFT_START_DATE",
  "type":"DATE_WITH_DAY",
  "value":"2012-04-23",
  "is_active":true
}

Request Headers:

Response Headers:

Required Roles:

CanGetBankAttribute - 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 getBankAttribute, operation_id: OBPv4.0.0-getBankAttribute Tags: Bank,

Get Bank Attributes

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_attribute_id: bank_attribute_id

bank_attributes: bank_attributes

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

is_active: false

Typical Successful Response:

								
									{
  "bank_attributes":[{
    "bank_id":"gh.29.uk",
    "bank_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
    "name":"OVERDRAFT_START_DATE",
    "type":"DATE_WITH_DAY",
    "value":"2012-04-23",
    "is_active":true
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetBankAttribute - 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 getBankAttributes, operation_id: OBPv4.0.0-getBankAttributes Tags: Bank,

Get Banks

Get banks on this API instance
Returns a list of banks supported on this server:

ID used as parameter in URLs
Short and full name of bank
Logo URL
Website

User Authentication is Optional. The User need not be logged in.

JSON response body fields:

bank_routings: bank routing in form of (scheme, address)

banks:

full_name: full name string

id: d8839721-ad8f-45dd-9f78-2080414b93f9

logo: logo url

name: ACCOUNT_MANAGEMENT_FEE

scheme: OBP

value: 5987953

attributes: attribute value in form of (name, value)

Typical Successful Response:

								
									{
  "banks":[{
    "id":"gh.29.uk",
    "short_name":"short_name ",
    "full_name":"full_name",
    "logo":"logo",
    "website":"www.openbankproject.com",
    "bank_routings":[{
      "scheme":"OBP",
      "address":"gh.29.uk"
    }],
    "attributes":[{
      "name":"ACCOUNT_MANAGEMENT_FEE",
      "value":"5987953"
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getBanks, operation_id: OBPv4.0.0-getBanks Tags: Bank, Account Information Service (AIS), PSD2,

Get Settlement accounts at Bank

Get settlement accounts on this API instance
Returns a list of settlement accounts at this Bank

Note: a settlement account is considered as a bank account.
So you can update it and add account attributes to it using the regular account endpoints

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

amount: 10.12

branch_id: DERBY6

label: My Account

name: ACCOUNT_MANAGEMENT_FEE

payment_system: SEPA

product_code: 1234BW

scheme: OBP

settlement_accounts:

value: 5987953

product_instance_code: product_instance_code

Typical Successful Response:

								
									{
  "settlement_accounts":[{
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "payment_system":"SEPA",
    "balance":{
      "currency":"EUR",
      "amount":"0"
    },
    "label":"My Account",
    "branch_id":"DERBY6",
    "account_routings":[{
      "scheme":"OBP",
      "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    }],
    "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",
      "product_instance_code":"LKJL98769F"
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetSettlementAccountAtOneBank - 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-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 getSettlementAccounts, operation_id: OBPv4.0.0-getSettlementAccounts Tags: Bank, PSD2,

Get Transaction Types at Bank

Get Transaction Types for the bank specified by BANK_ID:

Lists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).

id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.
bank_id : The bank that supports this TransactionType
short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here
summary : A succinct summary
description : A longer description
charge : The charge to the customer for each one of these

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

charge:

description: Description of the object. Maximum length is 2000. It can be any characters here.

id: d8839721-ad8f-45dd-9f78-2080414b93f9

short_code:

summary:

transaction_types:

value: 5987953

Typical Successful Response:

								
									{
  "transaction_types":[{
    "id":{
      "value":"123"
    },
    "bank_id":"gh.29.uk",
    "short_code":"PlaceholderString",
    "summary":"PlaceholderString",
    "description":"PlaceholderString",
    "charge":{
      "currency":"EUR",
      "amount":"0"
    }
  }]
}

Request Headers:

Response Headers:

Required Roles:

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: OBPv2.0.0, function_name: by getTransactionTypes, operation_id: OBPv2.0.0-getTransactionTypes Tags: Bank, Account Information Service (AIS), PSD2,

Update Bank

Update an existing bank (Authenticated access).

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

bank_code: CGHZ

bank_routings: bank routing in form of (scheme, address)

full_name: full name string

id: d8839721-ad8f-45dd-9f78-2080414b93f9

logo: logo url

name: ACCOUNT_MANAGEMENT_FEE

scheme: OBP

value: 5987953

attributes: attribute value in form of (name, value)

Typical Successful Response:

								
									{
  "id":"gh.29.uk",
  "bank_code":"CGHZ",
  "full_name":"bank fullName string",
  "logo":"bank logoUrl string",
  "website":"bank logoUrl string",
  "bank_routings":[{
    "scheme":"OBP",
    "address":"gh.29.uk"
  }],
  "attributes":[{
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "value":"5987953"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanCreateBank - 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-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-34001: Could not update the Bank
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv5.0.0, function_name: by updateBank, operation_id: OBPv5.0.0-updateBank Tags: Bank,

Update Bank Attribute

Update Bank Attribute.

Update one Bak Attribute by its id.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ATTRIBUTE_ID: BANK_ATTRIBUTE_ID

BANK_ID: gh.29.uk

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_active: false

name: ACCOUNT_MANAGEMENT_FEE

Typical Successful Response:

								
									{
  "name":"SPECIAL_TAX_NUMBER",
  "category":"Bank",
  "type":"STRING",
  "description":"description",
  "alias":"STRING",
  "can_be_seen_on_views":["bank"],
  "is_active":true
}

Request Headers:

Response Headers:

Required Roles:

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: OBPv4.0.0, function_name: by updateBankAttribute, operation_id: OBPv4.0.0-updateBankAttribute Tags: Bank,

Create Branch

Create Branch for the Bank.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

bank_id: gh.29.uk

branch_routing:

branch_type:

closing_time: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

longitude: -77.0364

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

scheme: OBP

JSON response body fields:

bank_id: gh.29.uk

branch_routing:

branch_type:

closing_time: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

longitude: -77.0364

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

scheme: OBP

Typical Successful Response:

								
									{
  "id":"branch-id-123",
  "bank_id":"bank-id-123",
  "name":"Branch by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"String",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":10.0,
    "longitude":10.0
  },
  "meta":{
    "license":{
      "id":"ODbL-1.0",
      "name":"Open Database License"
    }
  },
  "lobby":{
    "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"
    }]
  },
  "drive_up":{
    "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"
    }
  },
  "branch_routing":{
    "scheme":"OBP",
    "address":"123abc"
  },
  "is_accessible":"true",
  "accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
  "branch_type":"Full service store",
  "more_info":"short walk to the lake from here",
  "phone_number":"+381631954907"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateBranch - Please login to request this Role
CanCreateBranchAtAnyBank - 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-30209: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv3.0.0, function_name: by createBranch, operation_id: OBPv3.0.0-createBranch Tags: Branch,

Delete Branch

Delete Branch from given Bank.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

BRANCH_ID: DERBY6

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

Required Roles:

CanDeleteBranch - Please login to request this Role
CanDeleteBranchAtAnyBank - 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-30218: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv3.1.0, function_name: by deleteBranch, operation_id: OBPv3.1.0-deleteBranch Tags: Branch,

Get Branch

Returns information about a single Branch specified by BANK_ID and BRANCH_ID including:

Name
Address
Geo Location
License the data under this endpoint is released under.

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

BRANCH_ID: DERBY6

JSON response body fields:

bank_id: gh.29.uk

branch_routing:

branch_type:

closing_time: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

longitude: -77.0364

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

scheme: OBP

Typical Successful Response:

								
									{
  "id":"branch-id-123",
  "bank_id":"bank-id-123",
  "name":"Branch by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"String",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":10.0,
    "longitude":10.0
  },
  "meta":{
    "license":{
      "id":"ODbL-1.0",
      "name":"Open Database License"
    }
  },
  "lobby":{
    "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"
    }]
  },
  "drive_up":{
    "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"
    }
  },
  "branch_routing":{
    "scheme":"OBP",
    "address":"123abc"
  },
  "is_accessible":"true",
  "accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
  "branch_type":"Full service store",
  "more_info":"short walk to the lake from here",
  "phone_number":"+381631954907"
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-300010: Branch not found. Please specify a valid value for BRANCH_ID. Or License may not be set. meta.license.id and meta.license.name can not be empty
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.0.0, function_name: by getBranch, operation_id: OBPv3.0.0-getBranch Tags: Branch, Bank,

Get Branches for a Bank

Returns information about branches for a single bank specified by BANK_ID including:

Name
Address
Geo Location
License the data under this endpoint is released under
Structured opening hours
Accessible flag
Branch Type
More Info

Pagination:

By default, 50 records are returned.

You can use the url query parameters limit and offset for pagination
You can also use the follow url query parameters:

city - string, find Branches those in this city, optional
withinMetersOf - number, find Branches within given meters distance, optional
nearLatitude - number, a position of latitude value, cooperate with withMetersOf do query filter, optional
nearLongitude - number, a position of longitude value, cooperate with withMetersOf do query filter, optional

note: withinMetersOf, nearLatitude and nearLongitude either all empty or all have value.

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_id: gh.29.uk

closing_time: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

longitude: -77.0364

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

scheme: OBP

Typical Successful Response:

								
									{
  "branches":[{
    "id":"branch-id-123",
    "bank_id":"bank-id-123",
    "name":"Branch by the Lake",
    "address":{
      "line_1":"No 1 the Road",
      "line_2":"The Place",
      "line_3":"The Hill",
      "city":"Berlin",
      "county":"String",
      "state":"Brandenburg",
      "postcode":"13359",
      "country_code":"DE"
    },
    "location":{
      "latitude":10.0,
      "longitude":10.0
    },
    "meta":{
      "license":{
        "id":"ODbL-1.0",
        "name":"Open Database License"
      }
    },
    "lobby":{
      "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"
      }]
    },
    "drive_up":{
      "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"
      }
    },
    "branch_routing":{
      "scheme":"OBP",
      "address":"123abc"
    },
    "is_accessible":"true",
    "accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
    "branch_type":"Full service store",
    "more_info":"short walk to the lake from here",
    "phone_number":"+381631954907"
  }]
}

Request Headers:

Response Headers:

Required Roles:

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-32001: No branches available. License may not be set.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.0.0, function_name: by getBranches, operation_id: OBPv3.0.0-getBranches Tags: Branch, Bank,

Create Card

Create Card at bank specified by BANK_ID .

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

allows: [credit,debit,cash_withdrawal]

brand: Visa

card_number: 364435172576215

card_type: Credit

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

enabled: false

expires_date: 2021-01-27

name_on_card: SusanSmith

requested_date: 2020-01-27

serial_number: 1324234

technology: technology1

valid_from_date: 2020-01-27

collected: 2020-01-27

posted: 2020-01-27

replacement:

JSON response body fields:

allows: [credit,debit,cash_withdrawal]

bank_id: gh.29.uk

brand: Visa

can_add_tag: false

can_see_other_account_national_identifier: false

can_see_url: false

cancelled: false

card_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e

card_number: 364435172576215

card_type: Credit

collected: 2020-01-27

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

cvv: 123

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

expires_date: 2021-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

name_on_card: SusanSmith

on_hot_list: false

posted: 2020-01-27

requested_date: 2020-01-27

serial_number: 1324234

technology: technology1

valid_from_date: 2020-01-27

Typical Successful Response:

								
									{
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "bank_id":"gh.29.uk",
  "card_number":"364435172576215",
  "card_type":"Credit",
  "name_on_card":"SusanSmith",
  "issue_number":"1",
  "serial_number":"1324234",
  "valid_from_date":"1100-01-01T00:00:00Z",
  "expires_date":"1100-01-01T00:00:00Z",
  "enabled":true,
  "cancelled":true,
  "on_hot_list":true,
  "technology":"technology1",
  "networks":[""],
  "allows":["credit","debit"],
  "account":{
    "id":"123",
    "label":"OBP",
    "views_available":[{
      "id":"123",
      "short_name":"short_name",
      "description":"description",
      "is_public":true,
      "alias":"None",
      "hide_metadata_if_alias_used":true,
      "can_add_comment":true,
      "can_add_corporate_location":true,
      "can_add_image":true,
      "can_add_image_url":true,
      "can_add_more_info":true,
      "can_add_open_corporates_url":true,
      "can_add_physical_location":true,
      "can_add_private_alias":true,
      "can_add_public_alias":true,
      "can_add_tag":true,
      "can_add_url":true,
      "can_add_where_tag":true,
      "can_delete_comment":true,
      "can_delete_corporate_location":true,
      "can_delete_image":true,
      "can_delete_physical_location":true,
      "can_delete_tag":true,
      "can_delete_where_tag":true,
      "can_edit_owner_comment":true,
      "can_see_bank_account_balance":true,
      "can_see_bank_account_bank_name":true,
      "can_see_bank_account_currency":true,
      "can_see_bank_account_iban":true,
      "can_see_bank_account_label":true,
      "can_see_bank_account_national_identifier":true,
      "can_see_bank_account_number":true,
      "can_see_bank_account_owners":true,
      "can_see_bank_account_swift_bic":true,
      "can_see_bank_account_type":true,
      "can_see_comments":true,
      "can_see_corporate_location":true,
      "can_see_image_url":true,
      "can_see_images":true,
      "can_see_more_info":true,
      "can_see_open_corporates_url":true,
      "can_see_other_account_bank_name":true,
      "can_see_other_account_iban":true,
      "can_see_other_account_kind":true,
      "can_see_other_account_metadata":true,
      "can_see_other_account_national_identifier":true,
      "can_see_other_account_number":true,
      "can_see_other_account_swift_bic":true,
      "can_see_owner_comment":true,
      "can_see_physical_location":true,
      "can_see_private_alias":true,
      "can_see_public_alias":true,
      "can_see_tags":true,
      "can_see_transaction_amount":true,
      "can_see_transaction_balance":true,
      "can_see_transaction_currency":true,
      "can_see_transaction_description":true,
      "can_see_transaction_finish_date":true,
      "can_see_transaction_metadata":true,
      "can_see_transaction_other_bank_account":true,
      "can_see_transaction_start_date":true,
      "can_see_transaction_this_bank_account":true,
      "can_see_transaction_type":true,
      "can_see_url":true,
      "can_see_where_tag":true
    }],
    "bank_id":"gh.29.uk"
  },
  "replacement":{
    "requested_date":"1100-01-01T00:00:00Z",
    "reason_requested":"RENEW"
  },
  "pin_reset":[{
    "requested_date":"1100-01-01T00:00:00Z",
    "reason_requested":"FORGOT"
  }],
  "collected":"1100-01-01T00:00:00Z",
  "posted":"1100-01-01T00:00:00Z",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "cvv":"123",
  "brand":"Visa"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateCardsForBank - 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-10015: Allowed values are:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv5.0.0, function_name: by addCardForBank, operation_id: OBPv5.0.0-addCardForBank Tags: Card,

Create Card Attribute

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

Each Card Attribute is linked to its Card by CARD_ID

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

CARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e

JSON request body fields:

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

JSON response body fields:

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

Typical Successful Response:

								
									{
  "name":"OVERDRAFT_START_DATE",
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "attribute_type":"DOUBLE",
  "bank_id":{
    "value":"gh.29.uk"
  },
  "value":"2012-04-23",
  "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}

Request Headers:

Response Headers:

Required Roles:

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: OBPv3.1.0, function_name: by createCardAttribute, operation_id: OBPv3.1.0-createCardAttribute Tags: Card,

Create or Update Card Attribute Definition

The category field must be Card

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_id: gh.29.uk

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_active: false

name: ACCOUNT_MANAGEMENT_FEE

Typical Successful Response:

								
									{
  "attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "bank_id":"gh.29.uk",
  "name":"SPECIAL_TAX_NUMBER",
  "category":"Card",
  "type":"STRING",
  "description":"description",
  "alias":"STRING",
  "can_be_seen_on_views":["bank"],
  "is_active":true
}

Request Headers:

Response Headers:

Required Roles:

CanCreateCardAttributeDefinitionAtOneBank - 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 createOrUpdateCardAttributeDefinition, operation_id: OBPv4.0.0-createOrUpdateCardAttributeDefinition Tags: Card,

Delete Card

Delete a Card at bank specified by CARD_ID .

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

CARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

Required Roles:

CanCreateCardsForBank - 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-10015: Allowed values are:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.1.0, function_name: by deleteCardForBank, operation_id: OBPv3.1.0-deleteCardForBank Tags: Card,

Delete Card Attribute Definition

Delete Card Attribute Definition by ATTRIBUTE_DEFINITION_ID

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATTRIBUTE_DEFINITION_ID:

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

Required Roles:

CanDeleteCardAttributeDefinitionAtOneBank - 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 deleteCardAttributeDefinition, operation_id: OBPv4.0.0-deleteCardAttributeDefinition Tags: Card,

Get Card Attribute Definition

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

attributes: attribute value in form of (name, value)

bank_id: gh.29.uk

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_active: false

name: ACCOUNT_MANAGEMENT_FEE

Typical Successful Response:

								
									{
  "attributes":[{
    "attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "bank_id":"gh.29.uk",
    "name":"SPECIAL_TAX_NUMBER",
    "category":"Card",
    "type":"STRING",
    "description":"description",
    "alias":"STRING",
    "can_be_seen_on_views":["bank"],
    "is_active":true
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetCardAttributeDefinitionAtOneBank - 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 getCardAttributeDefinition, operation_id: OBPv4.0.0-getCardAttributeDefinition Tags: Card,

Get Card By Id

This will the datails of the card.
It shows the account infomation which linked the the card.
Also shows the card attributes of the card.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

CARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e

JSON response body fields:

allows: [credit,debit,cash_withdrawal]

bank_id: gh.29.uk

cancelled: false

card_attributes:

card_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e

card_number: 364435172576215

card_type: Credit

collected: 2020-01-27

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

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

expires_date: 2021-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

name: ACCOUNT_MANAGEMENT_FEE

name_on_card: SusanSmith

on_hot_list: false

posted: 2020-01-27

requested_date: 2020-01-27

serial_number: 1324234

technology: technology1

valid_from_date: 2020-01-27

value: 5987953

Typical Successful Response:

								
									{
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "bank_id":"gh.29.uk",
  "card_number":"364435172576215",
  "card_type":"Credit",
  "name_on_card":"SusanSmith",
  "issue_number":"1",
  "serial_number":"1324234",
  "valid_from_date":"1100-01-01T00:00:00Z",
  "expires_date":"1100-01-01T00:00:00Z",
  "enabled":true,
  "cancelled":true,
  "on_hot_list":true,
  "technology":"technologyString1",
  "networks":["networks1"],
  "allows":["credit","debit"],
  "account":{
    "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "label":"My Account",
    "views_available":[{
      "id":"owner",
      "name":"owner",
      "description":"This view is for the owner for the account."
    }],
    "bank_id":"gh.29.uk"
  },
  "replacement":{
    "requested_date":"1100-01-01T00:00:00Z",
    "reason_requested":"RENEW"
  },
  "pin_reset":[{
    "requested_date":"1100-01-01T00:00:00Z",
    "reason_requested":"FORGOT"
  }],
  "collected":"1100-01-01T00:00:00Z",
  "posted":"1100-01-01T00:00:00Z",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "card_attributes":[{
    "name":"OVERDRAFT_START_DATE",
    "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
    "attribute_type":"STRING",
    "bank_id":{
      "value":"gh.29.uk"
    },
    "value":"2012-04-23",
    "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetCardsForBank - 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: OBPv3.1.0, function_name: by getCardForBank, operation_id: OBPv3.1.0-getCardForBank Tags: Card,

Get Cards for the specified bank

Should be able to filter on the following fields

eg:/management/banks/BANK_ID/cards?customer_id=66214b8e-259e-44ad-8868-3eb47be70646&account_id=8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0

1 customer_id should be valid customer_id, otherwise, it will return an empty card list.

2 account_id should be valid account_id , otherwise, it will return an empty card list.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

allows: [credit,debit,cash_withdrawal]

bank_id: gh.29.uk

can_add_tag: false

can_see_other_account_national_identifier: false

can_see_url: false

cancelled: false

card_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e

card_number: 364435172576215

card_type: Credit

cards:

collected: 2020-01-27

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

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

expires_date: 2021-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

name_on_card: SusanSmith

on_hot_list: false

posted: 2020-01-27

requested_date: 2020-01-27

serial_number: 1324234

technology: technology1

valid_from_date: 2020-01-27

Typical Successful Response:

								
									{
  "cards":[{
    "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
    "bank_id":"gh.29.uk",
    "card_number":"364435172576215",
    "card_type":"Credit",
    "name_on_card":"SusanSmith",
    "issue_number":"1",
    "serial_number":"1324234",
    "valid_from_date":"1100-01-01T00:00:00Z",
    "expires_date":"1100-01-01T00:00:00Z",
    "enabled":true,
    "cancelled":true,
    "on_hot_list":true,
    "technology":"technologyString1",
    "networks":["networks1"],
    "allows":["credit","debit"],
    "account":{
      "id":"123",
      "label":"OBP",
      "views_available":[{
        "id":"123",
        "short_name":"short_name",
        "description":"description",
        "is_public":true,
        "alias":"None",
        "hide_metadata_if_alias_used":true,
        "can_add_comment":true,
        "can_add_corporate_location":true,
        "can_add_image":true,
        "can_add_image_url":true,
        "can_add_more_info":true,
        "can_add_open_corporates_url":true,
        "can_add_physical_location":true,
        "can_add_private_alias":true,
        "can_add_public_alias":true,
        "can_add_tag":true,
        "can_add_url":true,
        "can_add_where_tag":true,
        "can_delete_comment":true,
        "can_delete_corporate_location":true,
        "can_delete_image":true,
        "can_delete_physical_location":true,
        "can_delete_tag":true,
        "can_delete_where_tag":true,
        "can_edit_owner_comment":true,
        "can_see_bank_account_balance":true,
        "can_see_bank_account_bank_name":true,
        "can_see_bank_account_currency":true,
        "can_see_bank_account_iban":true,
        "can_see_bank_account_label":true,
        "can_see_bank_account_national_identifier":true,
        "can_see_bank_account_number":true,
        "can_see_bank_account_owners":true,
        "can_see_bank_account_swift_bic":true,
        "can_see_bank_account_type":true,
        "can_see_comments":true,
        "can_see_corporate_location":true,
        "can_see_image_url":true,
        "can_see_images":true,
        "can_see_more_info":true,
        "can_see_open_corporates_url":true,
        "can_see_other_account_bank_name":true,
        "can_see_other_account_iban":true,
        "can_see_other_account_kind":true,
        "can_see_other_account_metadata":true,
        "can_see_other_account_national_identifier":true,
        "can_see_other_account_number":true,
        "can_see_other_account_swift_bic":true,
        "can_see_owner_comment":true,
        "can_see_physical_location":true,
        "can_see_private_alias":true,
        "can_see_public_alias":true,
        "can_see_tags":true,
        "can_see_transaction_amount":true,
        "can_see_transaction_balance":true,
        "can_see_transaction_currency":true,
        "can_see_transaction_description":true,
        "can_see_transaction_finish_date":true,
        "can_see_transaction_metadata":true,
        "can_see_transaction_other_bank_account":true,
        "can_see_transaction_start_date":true,
        "can_see_transaction_this_bank_account":true,
        "can_see_transaction_type":true,
        "can_see_url":true,
        "can_see_where_tag":true
      }],
      "bank_id":"gh.29.uk"
    },
    "replacement":{
      "requested_date":"1100-01-01T00:00:00Z",
      "reason_requested":"RENEW"
    },
    "pin_reset":[{
      "requested_date":"1100-01-01T00:00:00Z",
      "reason_requested":"FORGOT"
    }],
    "collected":"1100-01-01T00:00:00Z",
    "posted":"1100-01-01T00:00:00Z",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
  }]
}

Request Headers:

Response Headers:

Required Roles:

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.

Connector Methods:

Version: OBPv3.1.0, function_name: by getCardsForBank, operation_id: OBPv3.1.0-getCardsForBank Tags: Card,

Get cards for the current user

Returns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

allows: [credit,debit,cash_withdrawal]

bank_card_number: 364435172576215

bank_id: gh.29.uk

can_add_tag: false

can_see_other_account_national_identifier: false

can_see_url: false

cancelled: false

cards:

collected: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

expires_date: 2021-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

name_on_card: SusanSmith

on_hot_list: false

posted: 2020-01-27

requested_date: 2020-01-27

serial_number: 1324234

technology: technology1

valid_from_date: 2020-01-27

Typical Successful Response:

								
									{
  "cards":[{
    "bank_id":"gh.29.uk",
    "bank_card_number":"364435172576215",
    "name_on_card":"String",
    "issue_number":"1",
    "serial_number":"1324234",
    "valid_from_date":"1100-01-01T00:00:00Z",
    "expires_date":"1100-01-01T00:00:00Z",
    "enabled":true,
    "cancelled":true,
    "on_hot_list":true,
    "technology":"String",
    "networks":["String"],
    "allows":["String"],
    "account":{
      "id":"123",
      "label":"OBP",
      "views_available":[{
        "id":"123",
        "short_name":"short_name",
        "description":"description",
        "is_public":true,
        "alias":"None",
        "hide_metadata_if_alias_used":true,
        "can_add_comment":true,
        "can_add_corporate_location":true,
        "can_add_image":true,
        "can_add_image_url":true,
        "can_add_more_info":true,
        "can_add_open_corporates_url":true,
        "can_add_physical_location":true,
        "can_add_private_alias":true,
        "can_add_public_alias":true,
        "can_add_tag":true,
        "can_add_url":true,
        "can_add_where_tag":true,
        "can_delete_comment":true,
        "can_delete_corporate_location":true,
        "can_delete_image":true,
        "can_delete_physical_location":true,
        "can_delete_tag":true,
        "can_delete_where_tag":true,
        "can_edit_owner_comment":true,
        "can_see_bank_account_balance":true,
        "can_see_bank_account_bank_name":true,
        "can_see_bank_account_currency":true,
        "can_see_bank_account_iban":true,
        "can_see_bank_account_label":true,
        "can_see_bank_account_national_identifier":true,
        "can_see_bank_account_number":true,
        "can_see_bank_account_owners":true,
        "can_see_bank_account_swift_bic":true,
        "can_see_bank_account_type":true,
        "can_see_comments":true,
        "can_see_corporate_location":true,
        "can_see_image_url":true,
        "can_see_images":true,
        "can_see_more_info":true,
        "can_see_open_corporates_url":true,
        "can_see_other_account_bank_name":true,
        "can_see_other_account_iban":true,
        "can_see_other_account_kind":true,
        "can_see_other_account_metadata":true,
        "can_see_other_account_national_identifier":true,
        "can_see_other_account_number":true,
        "can_see_other_account_swift_bic":true,
        "can_see_owner_comment":true,
        "can_see_physical_location":true,
        "can_see_private_alias":true,
        "can_see_public_alias":true,
        "can_see_tags":true,
        "can_see_transaction_amount":true,
        "can_see_transaction_balance":true,
        "can_see_transaction_currency":true,
        "can_see_transaction_description":true,
        "can_see_transaction_finish_date":true,
        "can_see_transaction_metadata":true,
        "can_see_transaction_other_bank_account":true,
        "can_see_transaction_start_date":true,
        "can_see_transaction_this_bank_account":true,
        "can_see_transaction_type":true,
        "can_see_url":true,
        "can_see_where_tag":true
      }],
      "bank_id":"gh.29.uk"
    },
    "replacement":{
      "requested_date":"1100-01-01T00:00:00Z",
      "reason_requested":"RENEW"
    },
    "pin_reset":[{
      "requested_date":"1100-01-01T00:00:00Z",
      "reason_requested":"FORGOT"
    }],
    "collected":"1100-01-01T00:00:00Z",
    "posted":"1100-01-01T00:00:00Z"
  }]
}

Request Headers:

Response Headers:

Required Roles:

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: OBPv1.3.0, function_name: by getCards, operation_id: OBPv1.3.0-getCards Tags: Card,

Get status of Credit Card order

Get status of Credit Card orders
Get all orders

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

card_description:

card_type: Credit

cards:

use_type:

Typical Successful Response:

								
									{
  "cards":[{
    "card_type":"5",
    "card_description":"good",
    "use_type":"3"
  }]
}

Request Headers:

Response Headers:

Required Roles:

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-50212: Connector did not return the set of status of credit card.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.1.0, function_name: by getStatusOfCreditCardOrder, operation_id: OBPv3.1.0-getStatusOfCreditCardOrder Tags: Card,

Update Card

Update Card at bank specified by CARD_ID .
User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

CARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e

JSON response body fields:

allows: [credit,debit,cash_withdrawal]

bank_id: gh.29.uk

can_add_tag: false

can_see_other_account_national_identifier: false

can_see_url: false

cancelled: false

card_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e

card_number: 364435172576215

card_type: Credit

collected: 2020-01-27

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

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

expires_date: 2021-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

name_on_card: SusanSmith

on_hot_list: false

posted: 2020-01-27

requested_date: 2020-01-27

serial_number: 1324234

technology: technology1

valid_from_date: 2020-01-27

Typical Successful Response:

								
									{
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "bank_id":"gh.29.uk",
  "card_number":"364435172576215",
  "card_type":"Credit",
  "name_on_card":"SusanSmith",
  "issue_number":"1",
  "serial_number":"1324234",
  "valid_from_date":"1100-01-01T00:00:00Z",
  "expires_date":"1100-01-01T00:00:00Z",
  "enabled":true,
  "cancelled":true,
  "on_hot_list":true,
  "technology":"technologyString1",
  "networks":["networks1"],
  "allows":["credit","debit"],
  "account":{
    "id":"123",
    "label":"OBP",
    "views_available":[{
      "id":"123",
      "short_name":"short_name",
      "description":"description",
      "is_public":true,
      "alias":"None",
      "hide_metadata_if_alias_used":true,
      "can_add_comment":true,
      "can_add_corporate_location":true,
      "can_add_image":true,
      "can_add_image_url":true,
      "can_add_more_info":true,
      "can_add_open_corporates_url":true,
      "can_add_physical_location":true,
      "can_add_private_alias":true,
      "can_add_public_alias":true,
      "can_add_tag":true,
      "can_add_url":true,
      "can_add_where_tag":true,
      "can_delete_comment":true,
      "can_delete_corporate_location":true,
      "can_delete_image":true,
      "can_delete_physical_location":true,
      "can_delete_tag":true,
      "can_delete_where_tag":true,
      "can_edit_owner_comment":true,
      "can_see_bank_account_balance":true,
      "can_see_bank_account_bank_name":true,
      "can_see_bank_account_currency":true,
      "can_see_bank_account_iban":true,
      "can_see_bank_account_label":true,
      "can_see_bank_account_national_identifier":true,
      "can_see_bank_account_number":true,
      "can_see_bank_account_owners":true,
      "can_see_bank_account_swift_bic":true,
      "can_see_bank_account_type":true,
      "can_see_comments":true,
      "can_see_corporate_location":true,
      "can_see_image_url":true,
      "can_see_images":true,
      "can_see_more_info":true,
      "can_see_open_corporates_url":true,
      "can_see_other_account_bank_name":true,
      "can_see_other_account_iban":true,
      "can_see_other_account_kind":true,
      "can_see_other_account_metadata":true,
      "can_see_other_account_national_identifier":true,
      "can_see_other_account_number":true,
      "can_see_other_account_swift_bic":true,
      "can_see_owner_comment":true,
      "can_see_physical_location":true,
      "can_see_private_alias":true,
      "can_see_public_alias":true,
      "can_see_tags":true,
      "can_see_transaction_amount":true,
      "can_see_transaction_balance":true,
      "can_see_transaction_currency":true,
      "can_see_transaction_description":true,
      "can_see_transaction_finish_date":true,
      "can_see_transaction_metadata":true,
      "can_see_transaction_other_bank_account":true,
      "can_see_transaction_start_date":true,
      "can_see_transaction_this_bank_account":true,
      "can_see_transaction_type":true,
      "can_see_url":true,
      "can_see_where_tag":true
    }],
    "bank_id":"gh.29.uk"
  },
  "replacement":{
    "requested_date":"1100-01-01T00:00:00Z",
    "reason_requested":"RENEW"
  },
  "pin_reset":[{
    "requested_date":"1100-01-01T00:00:00Z",
    "reason_requested":"FORGOT"
  }],
  "collected":"1100-01-01T00:00:00Z",
  "posted":"1100-01-01T00:00:00Z",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}

Request Headers:

Response Headers:

Required Roles:

CanUpdateCardsForBank - 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-10015: Allowed values are:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.1.0, function_name: by updatedCardForBank, operation_id: OBPv3.1.0-updatedCardForBank Tags: Card,

Update Card Attribute

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

Each Card Attribute is linked to its Card by CARD_ID

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

CARD_ATTRIBUTE_ID: b4e0352a-9a0f-4bfa-b30b-9003aa467f50

CARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e

JSON response body fields:

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

Typical Successful Response:

								
									{
  "name":"OVERDRAFT_START_DATE",
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "attribute_type":"DOUBLE",
  "bank_id":{
    "value":"gh.29.uk"
  },
  "value":"2012-04-23",
  "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}

Request Headers:

Response Headers:

Required Roles:

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: OBPv3.1.0, function_name: by updateCardAttribute, operation_id: OBPv3.1.0-updateCardAttribute Tags: Card,

Create Connector Method

Create an internal connector.

The method_body is URL-encoded format String

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									{
  "connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51",
  "method_name":"getBank",
  "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29",
  "programming_lang":"Scala"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateConnectorMethod - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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

Connector Methods:

Version: OBPv4.0.0, function_name: by createConnectorMethod, operation_id: OBPv4.0.0-createConnectorMethod Tags: Connector-Method,

Get Connector Method by Id

Get an internal connector by CONNECTOR_METHOD_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

JSON response body fields:

Typical Successful Response:

								
									{
  "connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51",
  "method_name":"getBank",
  "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29",
  "programming_lang":"Scala"
}

Request Headers:

Response Headers:

Required Roles:

CanGetConnectorMethod - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getConnectorMethod, operation_id: OBPv4.0.0-getConnectorMethod Tags: Connector-Method,

Get all Connector Methods

Get all Connector Methods.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

Typical Successful Response:

								
									{
  "connectors_methods":[{
    "connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51",
    "method_name":"getBank",
    "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29",
    "programming_lang":"Scala"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetAllConnectorMethods - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getAllConnectorMethods, operation_id: OBPv4.0.0-getAllConnectorMethods Tags: Connector-Method,

Update Connector Method

Update an internal connector.

The method_body is URL-encoded format String

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

JSON response body fields:

Typical Successful Response:

								
									{
  "connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51",
  "method_name":"getBank",
  "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29",
  "programming_lang":"Scala"
}

Request Headers:

Response Headers:

Required Roles:

CanUpdateConnectorMethod - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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

Connector Methods:

Version: OBPv4.0.0, function_name: by updateConnectorMethod, operation_id: OBPv4.0.0-updateConnectorMethod Tags: Connector-Method,

Add User to a Consent

This endpoint is used to add the User of Consent.

Each Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, RECEIVED, received, VALID, valid, REVOKEDBYPSU, revokedByPsu, EXPIRED, expired, TERMINATEDBYTPP, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

CONSENT_ID:

JSON response body fields:

consent_id:

jwt:

Typical Successful Response:

								
									{
  "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945",
  "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4",
  "status":"AUTHORISED"
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20057: User not found by userId.
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-35024: The Consent's User is already added.
OBP-10001: Incorrect json format.
OBP-35001: Consent not found by CONSENT_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by addConsentUser, operation_id: OBPv4.0.0-addConsentUser Tags: Consent, Account Information Service (AIS),

Answer Consent Challenge

An OBP Consent allows the holder of the Consent to call one or more endpoints.

Consents must be created and authorisied using SCA (Strong Customer Authentication).

That is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.

Each Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, RECEIVED, received, VALID, valid, REVOKEDBYPSU, revokedByPsu, EXPIRED, expired, TERMINATEDBYTPP, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.

Each Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
For example:
GET /obp/v4.0.0/users/current HTTP/1.1
Host: 127.0.0.1:8080
Consent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
EtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
zcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
tNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg

Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
cache-control: no-cache

Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.

Example of POST JSON:
{
"everything": false,
"views": [
{
"bank_id": "GENODEM1GLS",
"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"view_id": "owner"
}
],
"entitlements": [
{
"bank_id": "GENODEM1GLS",
"role_name": "CanGetCustomer"
}
],
"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"email": "eveline@example.com",
"valid_from": "2020-02-07T08:43:34Z",
"time_to_live": 3600
}
Please note that only optional fields are: consumer_id, valid_from and time_to_live.
In case you omit they the default values are used:
consumer_id = consumer of current user
valid_from = current time
time_to_live = consents.max_time_to_live

This endpoint is used to confirm a Consent previously created.

The User must supply a code that was sent out of band (OOB) for example via an SMS.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

CONSENT_ID:

JSON request body fields:

answer:

JSON response body fields:

consent_id:

jwt: