The full set of FSBT TECH APIs.
-
API
- Create sandbox
- Enable or Disable Consumers
- Get Adapter Info
- Get Connector Metrics
- Get Consumer
- Get Consumers
- Get Message Docs
- Get Metrics
- Get Resource Docs in OBP format.
- Get Resource Docs in Swagger format.
- Search API Metrics via Elasticsearch.
- Test Resource Doc.
- The configuration of the API
- The root of the API
- Update Consumer RedirectUrl
-
ATM
-
Account
- Create Account
- Create View.
- Delete View
- Get Account access for User.
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts at Bank (Public)
- Get Accounts at Bank (inc. Public).
- Get Accounts at all Banks (Private)
- Get Counterparty by Counterparty Id.
- Get Firehose Accounts at one Bank (Firehose)
- Get Firehose Transactions for Account (Firehose)
- Get Public Accounts at all Banks.
- Get Views for Account.
- Get access.
- Get private accounts at one bank.
- Get private accounts ids at one bank.
- Grant User access to View.
- Grant User access to a list of views.
- Revoke access to all Views on Account
- Revoke access to one View.
- Update Account Label.
- Update View.
-
Bank
-
Branch
-
Card
-
Counterparty
-
CounterpartyMetaData
- Add Corporate Location to Counterparty
- Add Counterparty More Info
- Add Open Corporates URL to Counterparty
- Add image url to other bank account.
- Add physical location to other bank account.
- Add public alias to other bank account.
- Add url to other bank account.
- Create Other Account Private Alias
- Delete Counterparty Corporate Location.
- Delete Counterparty Image URL
- Delete Counterparty Open Corporates URL
- Delete Counterparty Physical Location.
- Delete Counterparty Private Alias
- Delete Counterparty Public Alias
- Delete more info of other bank account.
- Delete url of other bank account.
- Get Other Account Metadata.
- Get Other Account Private Alias
- Get public alias of other bank account.
- Update Counterparty Corporate Location
- Update Counterparty Image Url
- Update Counterparty More Info
- Update Counterparty Physical Location
- Update Counterparty Private Alias
- Update Open Corporates Url of Counterparty
- Update public alias of other bank account.
- Update url of other bank account.
-
Customer
-
Data Warehouse
-
FX
-
KYC
-
Meeting
-
Message
-
Product
-
Role
- Add Entitlement Request for a Logged User.
- Add Entitlement for a User.
- Delete Entitlement
- Delete Entitlement Request
- Get Entitlement Requests for a User.
- Get Entitlement Requests for the current User.
- Get Entitlements for User
- Get Entitlements for User at Bank.
- Get Entitlements for the current User.
- Get Roles
- Get all Entitlement Requests
- Get all Entitlements
-
Transaction
-
TransactionMetaData
-
TransactionRequest
- Answer Transaction Request Challenge.
- Create Transaction Request (COUNTERPARTY)
- Create Transaction Request (FREE_FORM).
- Create Transaction Request (SANDBOX_TAN)
- Create Transaction Request (SEPA)
- Get Transaction Request Types for Account
- Get Transaction Requests.
- Get supported Transaction Request Types
-
User
FSBT TECH APIs v3.0.0 (all tags) (157)
Bank
Accounts
Views
Counterparties
Transactions
Create sandbox
Import bulk data into the sandbox (Authenticated access).
This call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.
The user needs to have CanCreateSandbox entitlement.
An example of an import set of data (json) can be found here Authentication is Mandatory
{
"success":"Success"
}
-
CanCreateSandbox
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-00002: Data import is disabled for this API instance.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Enable or Disable Consumers
Enable/Disable a Consumer specified by CONSUMER_ID.
{
"enabled":false
}
-
CanEnableConsumers
- Please login to request this Role
-
CanDisableConsumers
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Adapter Info
Get basic information about the Adapter listening on behalf of this bank.
Authentication is Mandatory
{
"name":"String",
"version":"String",
"git_commit":"String",
"date":"2013-01-21T23:08:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Connector Metrics
Get the all metrics
require $CanGetConnectorMetrics role
Filters Part 1.*filtering* (no wilde cards etc.) parameters to GET /management/connector/metrics
Should be able to filter on the following metrics fields
eg: /management/connector/metrics?start_date=2017-03-01&end_date=2017-03-04&limit=50&offset=2
1 start_date (defaults to one week before current date): eg:start_date=2017-03-01
2 end_date (defaults to current date) eg:end_date=2017-03-05
3 limit (for pagination: defaults to 1000) eg:limit=2000
4 offset (for pagination: zero index, defaults to 0) eg: offset=10
eg: /management/connector/metrics?start_date=2016-03-05&end_date=2017-03-08&limit=100&offset=300
Other filters:
5 connector_name (if null ignore)
6 function_name (if null ignore)
7 correlation_id (if null ignore)
{
"metrics":[{
"connector_name":"mapper",
"function_name":"getBanks",
"correlation_id":"12345",
"date":"2013-01-22T00:08:00Z",
"duration":1000
}]
}
-
CanGetConnectorMetrics
- Please login to request this Role
- OBP-10005: Invalid Date Format. Could not convert value to a Date.
- OBP-50000: Unknown Error.
Get Consumer
Get the Consumer specified by CONSUMER_ID.
{
"consumer_id":1213,
"app_name":"SOFI",
"app_type":"Web",
"description":"Account Management",
"developer_email":"contact@tesobe.com",
"redirect_url":"www.openbankproject.com",
"created_by_user_id":"123213",
"created_by_user":{
"user_id":"123",
"email":"contact@tesobe.com",
"provider_id":"obp",
"provider":"obp",
"username":"TESOBE"
},
"enabled":true,
"created":"2013-01-22T00:08:00Z"
}
-
CanGetConsumers
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
- OBP-50000: Unknown Error.
Get Consumers
Get the all Consumers.
{
"list":[{
"consumer_id":1213,
"app_name":"SOFI",
"app_type":"Web",
"description":"Account Management",
"developer_email":"contact@tesobe.com",
"redirect_url":"www.openbankproject.com",
"created_by_user_id":"123213",
"created_by_user":{
"user_id":"123",
"email":"contact@tesobe.com",
"provider_id":"obp",
"provider":"obp",
"username":"TESOBE"
},
"enabled":true,
"created":"2013-01-22T00:08:00Z"
}]
}
-
CanGetConsumers
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Message Docs
These message docs provide example messages sent by OBP to the (Kafka) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes. Integrators can use these messages to build Adapters that provide core banking services to OBP.
CONNECTOR
: kafka_vJuneYellow2017, kafka_vJune2017 , kafka_vMar2017 or ...
{
"message_docs":[{
"process":"getBanks",
"message_format":"KafkaV2017",
"description":"get Banks",
"example_outbound_message":{
},
"example_inbound_message":{
}
}]
}
- OBP-50000: Unknown Error.
Get Metrics
Get the all metrics
require CanReadMetrics role
Filters Part 1.*filtering* (no wilde cards etc.) parameters to GET /management/metrics
Should be able to filter on the following metrics fields
eg: /management/metrics?start_date=2017-03-01&end_date=2017-03-04&limit=50&offset=2
1 start_date (defaults to one week before current date): eg:start_date=2017-03-01
2 end_date (defaults to current date) eg:end_date=2017-03-05
3 limit (for pagination: defaults to 200) eg:limit=200
4 offset (for pagination: zero index, defaults to 0) eg: offset=10
eg: /management/metrics?start_date=2016-03-05&end_date=2017-03-08&limit=10000&offset=0&anon=false&app_name=hognwei&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78
Other filters:
5 consumer_id (if null ignore)
6 user_id (if null ignore)
7 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
8 url (if null ignore), note: can not contain '&'.
9 app_name (if null ignore)
10 implemented_by_partial_function (if null ignore),
11 implemented_in_version (if null ignore)
12 verb (if null ignore)
{
"metrics":[{
"user_id":"134",
"url":"www.openbankproject.com",
"date":"2013-01-22T00:08:00Z",
"user_name":"OBP",
"app_name":"SOFI",
"developer_email":"contact@tesobe.ocm",
"implemented_by_partial_function":"getBanks",
"implemented_in_version":"v210",
"consumer_id":"123",
"verb":"get"
}]
}
-
CanReadMetrics
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Resource Docs in OBP format.
Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.
This endpoint is used by OBP API Explorer to display and work with the API documentation.
Most (but not all) fields are also available in swagger format.
API_VERSION is the version you want documentation about e.g. v3.0.0
You may query this endpoint with tags parameter e.g. ?tags=Account,Bank
You may query this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.
- operation_id is concatenation of "v", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code)
- version references the version that the API call is defined in.
- function is the (scala) partial function that implements this endpoint. It is unique per version of the API.
- request_url is empty for the root call, else the path.
- summary is a short description inline with the swagger terminology.
- description may contain html markup (generated from markdown on the server).
{
}
- OBP-50000: Unknown Error.
Get Resource Docs in Swagger format.
Returns documentation about the RESTful resources on this server in Swagger format.
The information returned in this endpoint is continuously being enhanced.
API_VERSION is the version you want documentation about e.g. v3.0.0
You may query this endpoint with tags parameter e.g. ?tags=Account,Bank
You may query this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
See the Resource Doc endpoint for more information.
{
}
- OBP-50000: Unknown Error.
Search API Metrics via Elasticsearch.
Search the API calls made to this API instance via Elastic Search.
Login is required.
CanSearchMetrics entitlement is required to search metrics data.
parameters:
esType - elasticsearch type
simple query:
q - plain_text_query
df - default field to search
sort - field to sort on
size - number of hits returned, default 10
from - show hits starting from
json query:
source - JSON_query_(URL-escaped)
example usage:
/search/metrics/q=findThis
or:
/search/metrics/source={"query":{"query_string":{"query":"findThis"}}}
Note!!
The whole JSON query string MUST be URL-encoded:
- For { use %7B
- For } use %7D
- For : use %3A
- For " use %22
etc..
Only q, source and esType are passed to Elastic
Elastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html
Elastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html
{
}
-
CanSearchMetrics
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Test Resource Doc.
I am only a test Resource Doc
This should be H1
This should be H2
This should be H3
This should be H4
Here is a list with two items:
- One
- Two
There are underscores by them selves _
There are underscores around a word
There are underscores_in_words
There are 'underscores_in_words_inside_quotes'
There are (underscores_in_words_in_brackets)
etc...
{
}
- OBP-50000: Unknown Error.
The configuration of the API
Returns information about:
- Akka ports
- Elastic search ports
- Cached function
{
"akka":{
"ports":[{
"property":"default",
"value":"8080"
}],
"log_level":"Debug"
},
"elastic_search":{
"metrics":[{
"property":"String",
"value":"Mapper"
}],
"warehouse":[{
"property":"String",
"value":"ElasticSearch"
}]
},
"cache":[{
"function_name":"getBanks",
"ttl_in_seconds":5
}]
}
-
CanGetConfig
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
The root of the API
Returns information about:
- API version
- Hosted by information
- Git Commit
{
"version":"String",
"version_status":"String",
"git_commit":"String",
"connector":"String",
"hosted_by":{
"organisation":"String",
"email":"String",
"phone":"String"
},
"akka":{
"remote_data_secret_matched":true
}
}
- OBP-50000: Unknown Error.
- no connector set
Update Consumer RedirectUrl
Update an existing redirectUrl for a Consumer specified by CONSUMER_ID.
CONSUMER_ID can be obtained after you register the application.
Or use the endpoint 'Get Consumers' to get it
{
"consumer_id":1213,
"app_name":"SOFI",
"app_type":"Web",
"description":"Account Management",
"developer_email":"contact@tesobe.com",
"redirect_url":"www.openbankproject.com",
"created_by_user_id":"123213",
"created_by_user":{
"user_id":"123",
"email":"contact@tesobe.com",
"provider_id":"obp",
"provider":"obp",
"username":"TESOBE"
},
"enabled":true,
"created":"2013-01-22T00:08:00Z"
}
-
CanUpdateConsumerRedirectUrl
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Create ATM
Create ATM for the Bank.
Authentication is Mandatory
OBP-20006: User is missing one or more roles: CanCreateAtm OR CanCreateAtmAtAnyBank
{
"id":"atm-id-123",
"bank_id":"bank-id-123",
"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":"5",
"name":"TESOBE"
}
},
"monday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"tuesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"wednesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"thursday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"friday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"saturday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"sunday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"is_accessible":"true",
"located_at":"Full service store",
"more_info":"short walk to the lake from here",
"has_deposit_capability":"true"
}
-
CanCreateAtm
- Please login to request this Role
-
CanCreateAtmAtAnyBank
- Please login to request this Role
- 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.
Get Bank ATM
Returns information about ATM for a single bank specified by BANK_ID and ATM_ID including:
- Address
- Geo Location
- License the data under this endpoint is released under
Authentication is Optional
{
"id":"atm-id-123",
"bank_id":"bank-id-123",
"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":"5",
"name":"TESOBE"
}
},
"monday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"tuesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"wednesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"thursday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"friday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"saturday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"sunday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"is_accessible":"true",
"located_at":"Full service store",
"more_info":"short walk to the lake from here",
"has_deposit_capability":"true"
}
- OBP-20001: User not logged in. Authentication is required!
- 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.
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
Authentication is Optional
{
"id":"atm-id-123",
"bank_id":"bank-id-123",
"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":"5",
"name":"TESOBE"
}
},
"monday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"tuesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"wednesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"thursday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"friday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"saturday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"sunday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"is_accessible":"true",
"located_at":"Full service store",
"more_info":"short walk to the lake from here",
"has_deposit_capability":"true"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- No ATMs available. License may not be set.
- OBP-50000: Unknown Error.
Create Account
Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.
The User can create an Account for themself or an Account for another User if they have CanCreateAccount role.
If USER_ID is not specified the account will be owned by the logged in User.
Note: The Amount must be zero.
{
"user_id":"66214b8e-259e-44ad-8868-3eb47be70646",
"label":"Label",
"type":"CURRENT",
"balance":{
"currency":"EUR",
"amount":"0"
},
"branch_id":"1234",
"account_routing":{
"scheme":"OBP",
"address":"UK123456"
}
}
-
CanCreateAccount
- Please login to request this Role
- 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.
Create View.
Create a view on bank account
OAuth authentication is required and the user needs to have access to the owner view. The 'alias' field in the JSON can take one of three values:
- public: to use the public alias if there is one specified for the other account.
- private: to use the public alias if there is one specified for the other account.
-
''(empty string): to use no alias; the view shows the real name of the other account.
The 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to true
and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.
The 'allowed_actions' field is a list containing the name of the actions allowed on this view, all the actions contained will be set to true
on the view creation, the rest will be set to false
.
You should use a leading _ (underscore) for the view name because other view names may become reserved by OBP internally
{
"id":"1234",
"short_name":"short_name",
"description":"description",
"is_public":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_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
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50000: Unknown Error.
Delete View
Deletes the view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID.
{
}
- 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.
- user does not have owner access
Get Account access for User.
Returns the list of the views at BANK_ID for account ACCOUNT_ID that a USER_ID at their provider PROVIDER_ID has access to. All url parameters must be %-encoded, which is often especially relevant for USER_ID and PROVIDER_ID.
Authentication is Mandatory
The user needs to have access to the owner view.
{
"views":[{
"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
}]
}
- OBP-20001: User not logged in. Authentication is required!
- 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-50000: Unknown Error.
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
This call returns the owner view and requires access to that view.
OAuth authentication is required
This endpoint works with firehose.
{
"id":"String",
"bank_id":"String",
"label":"String",
"number":"String",
"owners":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}],
"type":"String",
"balance":{
"currency":"EUR",
"amount":"10"
},
"account_routings":[{
"scheme":"IBAN",
"address":"DE89 3704 0044 0532 0130 00"
}],
"account_rules":[{
"scheme":"OVERDRAFT",
"value":"10"
}]
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50000: Unknown Error.
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 authenticaiton using OAuth.
Authentication is required if the 'is_public' field in view (VIEW_ID) is not set to true
.
This endpoint works with firehose.
{
"id":"String",
"bank_id":"String",
"label":"String",
"number":"String",
"owners":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}],
"type":"String",
"balance":{
"currency":"EUR",
"amount":"10"
},
"views_available":[{
"id":"1234",
"short_name":"short_name",
"description":"description",
"is_public":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_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
}],
"account_routing":{
"scheme":"IBAN",
"address":"DE89 3704 0044 0532 0130 00"
}
}
- 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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-50000: Unknown Error.
Get Accounts at Bank (Public)
Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.
Authentication via OAuth is not required.
This endpoint works with firehose.
{
"accounts":[{
"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"label":"NoneLabel",
"bank_id":"gh.29.uk",
"views_available":[{
"id":"1",
"short_name":"HHH",
"is_public":true
}]
}]
}
- OBP-50000: Unknown Error.
Get Accounts at Bank (inc. Public).
Get accounts at one bank that the user has access to (Authenticated + Anonymous access). 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 available views.
If the user is not authenticated, the list will contain only the accounts providing public views.
This endpoint works with firehose.
Authentication is Optional
{
"accounts":[{
"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"label":"NoneLabel",
"bank_id":"gh.29.uk",
"views_available":[{
"id":"1",
"short_name":"HHH",
"is_public":true
}]
}]
}
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-50000: Unknown Error.
Get Accounts at all Banks (Private)
Get private accounts at all banks (Authenticated access) Returns the list of accounts containing private views for the user at all banks. For each account the API returns the ID and the available views.
Authentication is Mandatory
{
"accounts":[{
"id":"String",
"label":" String",
"bank_id":" String",
"account_routing":{
"scheme":"String",
"address":"String"
}
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Counterparty by Counterparty Id.
Information returned about the Counterparty specified by COUNTERPARTY_ID:
Authentication is Mandatory
This endpoint works with firehose.
{
"name":"CounterpartyName",
"description":"My landlord",
"created_by_user_id":"49e1e147-64c1-4823-ad9f-89efcd02a9fa",
"this_bank_id":"gh.29.uk",
"this_account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"this_view_id":"owner",
"counterparty_id":"1d65db7c-a7b2-4839-af41-958276ab7790",
"other_bank_routing_scheme":"bankCode",
"other_bank_routing_address":"bankCode",
"other_branch_routing_scheme":"bankCode",
"other_branch_routing_address":"bankCode",
"other_account_routing_scheme":"bankCode",
"other_account_routing_address":"bankCode",
"other_account_secondary_routing_scheme":"bankCode",
"other_account_secondary_routing_address":"bankCode",
"is_beneficiary":true,
"bespoke":[{
"key":"englishName",
"value":"english Name"
}],
"metadata":{
"public_alias":"String",
"more_info":null,
"url":null,
"image_url":null,
"open_corporates_url":null,
"corporate_location":null,
"physical_location":null,
"private_alias":null
}
}
- 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.
Get Firehose Accounts at one Bank (Firehose)
Get firehose accounts at one bank.
Authentication is Mandatory
{
"accounts":[{
"id":"String",
"bank_id":"String",
"label":"String",
"number":"String",
"owners":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}],
"type":"String",
"balance":{
"currency":"EUR",
"amount":"10"
},
"account_routings":[{
"scheme":"IBAN",
"address":"DE89 3704 0044 0532 0130 00"
}],
"account_rules":[{
"scheme":"OVERDRAFT",
"value":"10"
}]
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Firehose Transactions for Account (Firehose)
Get firehose transactions for Account.
Authentication is Mandatory
{
"transactions":[{
"id":"String",
"this_account":{
"id":"String",
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
},
"account_routing":{
"scheme":"IBAN",
"address":"DE89 3704 0044 0532 0130 00"
},
"holders":[{
"name":"OBP",
"is_alias":true
}]
},
"other_account":{
"id":"String",
"holder":{
"name":"OBP",
"is_alias":true
},
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
},
"account_routing":{
"scheme":"IBAN",
"address":"DE89 3704 0044 0532 0130 00"
},
"metadata":{
"public_alias":"NONE",
"private_alias":"NONE",
"more_info":"www.openbankproject.com",
"url":"www.openbankproject.com",
"image_url":"www.openbankproject.com",
"open_corporates_url":"www.openbankproject.com",
"corporate_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
},
"physical_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}
}
},
"details":{
"type":"AC",
"description":"GOOD",
"posted":"2013-01-22T00:08:00Z",
"completed":"2013-01-22T00:08:00Z",
"new_balance":{
"currency":"EUR",
"amount":"10"
},
"value":{
"currency":"EUR",
"amount":"10"
}
},
"metadata":{
"narrative":"NONE",
"comments":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}],
"tags":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}],
"images":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"NONE",
"url":"www.openbankproject.com",
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}],
"where":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}
}
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-00009: Firehose views not allowed on this instance. Please set allow_firehose_views = true in props files.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
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.
Authentication is Optional
This endpoint works with firehose.
{
"accounts":[{
"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"label":"NoneLabel",
"bank_id":"gh.29.uk",
"views_available":[{
"id":"1",
"short_name":"HHH",
"is_public":true
}]
}]
}
- OBP-20001: User not logged in. Authentication is required!
- Could not get accounts.
- OBP-50000: Unknown Error.
Get Views for Account.
Views
Views in Open Bank Project provide a mechanism for fine grained access control and delegation to Accounts and Transactions. Account holders use the 'owner' view by default. Delegated access is made through other views for example 'accountants', 'share-holders' or 'tagging-application'. Views can be created via the API and each view has a list of entitlements.
Views on accounts and transactions filter the underlying data to redact certain fields for certain users. For instance the balance on an account may be hidden from the public. The way to know what is possible on a view is determined in the following JSON.
Data: When a view moderates a set of data, some fields my contain the value null
rather than the original value. This indicates either that the user is not allowed to see the original data or the field is empty.
There is currently one exception to this rule; the 'holder' field in the JSON contains always a value which is either an alias or the real name - indicated by the 'is_alias' field.
Action: When a user performs an action like trying to post a comment (with POST API call), if he is not allowed, the body response will contain an error message.
Metadata: Transaction metadata (like images, tags, comments, etc.) will appears ONLY on the view where they have been created e.g. comments posted to the public view only appear on the public view.
The other account metadata fields (like image_URL, more_info, etc.) are unique through all the views. Example, if a user edits the 'more_info' field in the 'team' view, then the view 'authorities' will show the new value (if it is allowed to do it).
All
Optional
Returns the list of the views created for account ACCOUNT_ID at BANK_ID.
OAuth authentication is required and the user needs to have access to the owner view.
{
"views":[{
"id":"1234",
"short_name":"short_name",
"description":"description",
"is_public":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_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
}]
}
- 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.
Get access.
Returns the list of the permissions at BANK_ID for account ACCOUNT_ID, with each time a pair composed of the user and the views that he has access to.
OAuth authentication is required and the user needs to have access to the owner view.
{
"permissions":[{
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
},
"views":[{
"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
}]
}]
}
- OBP-20001: User not logged in. Authentication is required!
- 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-50000: Unknown Error.
Get private accounts at one bank.
Returns the list of private accounts at BANK_ID that the user has access to. For each account the API returns the ID and the available views.
If you want to see more information on the Views, use the Account Detail call. If you want less information about the account, use the /my accounts call
Authentication is Mandatory
{
"accounts":[{
"id":"String",
"label":" String",
"bank_id":" String",
"account_routing":{
"scheme":"String",
"address":"String"
}
}]
}
- 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.
Get private accounts ids at one bank.
Returns the list of private accounts ids at BANK_ID that the user has access to. For each account the API returns the ID
If you want to see more information on the Views, use the Account Detail call.
Authentication is Mandatory
{
"accounts":[{
"id":"String"
}]
}
- 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.
Grant User access to View.
Grants the user USER_ID at their provider PROVIDER_ID access to the view VIEW_ID at BANK_ID for account ACCOUNT_ID. All url parameters must be %-encoded, which is often especially relevant for USER_ID and PROVIDER_ID.
OAuth authentication is required and the user needs to have access to the owner view.
Granting access to a public view will return an error message, as the user already has access.
{
"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
}
- 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.
- could not save the privilege
- user does not have access to owner view on account
Grant User access to a list of views.
Grants the user USER_ID at their provider PROVIDER_ID access to a list of views at BANK_ID for account ACCOUNT_ID.
All url parameters must be %-encoded, which is often especially relevant for USER_ID and PROVIDER_ID.
Authentication is Mandatory
The User needs to have access to the owner view.
{
"views":[{
"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
}]
}
- 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.
- wrong format JSON
- could not save the privilege
- user does not have access to owner view on account
Revoke access to all Views on Account
Revokes the user USER_ID at their provider PROVIDER_ID access to all the views at BANK_ID for account ACCOUNT_ID.
OAuth authentication is required and the user needs to have access to the owner view.
{
}
- 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.
- user does not have access to owner view on account
Revoke access to one View.
Revokes the user USER_ID at their provider PROVIDER_ID access to the view VIEW_ID at BANK_ID for account ACCOUNT_ID.
Revoking a user access to a public view will return an error message.
OAuth authentication is required and the user needs to have access to the owner view.
{
}
- 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.
- could not save the privilege
- user does not have access to owner view on account
- OBP-50000: Unknown Error.
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'
{
"success":"Success"
}
- 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.
- user does not have access to owner view on account
Update View.
Update an existing view on a bank account
OAuth authentication is required and the user needs to have access to the owner view.
The json sent is the same as during view creation (above), with one difference: the 'name' field of a view is not editable (it is only set when a view is created)
{
"id":"1234",
"short_name":"short_name",
"description":"description",
"is_public":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_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
}
- OBP-10001: Incorrect json format.
- 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.
Create Bank
Create a new bank (Authenticated access). Authentication is Mandatory
{
"id":"gh.29.uk.x",
"full_name":"uk",
"short_name":"uk",
"logo_url":"https://static.openbankproject.com/images/sandbox/bank_x.png",
"website_url":"https://www.example.com",
"swift_bic":"IIIGGB22",
"national_identifier":"UK97ZZZ1234567890",
"bank_routing":{
"scheme":"BIC",
"address":"OKOYFIHH"
}
}
-
CanCreateBank
- Please login to request this Role
- 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.
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
Authentication is Mandatory
{
"id":{
"value":"123"
},
"bank_id":{
"value":"gh.uk.9j"
},
"short_code":"80080",
"summary":"good",
"description":"good",
"charge":{
"currency":"EUR",
"amount":"100"
}
}
-
CanCreateTransactionType
- Please login to request this Role
- 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.
Get Bank
Get the bank specified by BANK_ID Returns information about a single bank specified by BANK_ID including:
- Short and full name of bank
- Logo URL
- Website
{
"id":"gh.29.uk",
"short_name":"short_name ",
"full_name":"full_name",
"logo":"logo",
"website":"www.openbankproject.com",
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
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
{
"banks":[{
"id":"gh.29.uk",
"short_name":"short_name ",
"full_name":"full_name",
"logo":"logo",
"website":"www.openbankproject.com",
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
}
}]
}
- OBP-50000: Unknown Error.
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
Authentication is Optional
{
"transaction_types":[{
"id":{
"value":"123"
},
"bank_id":"PlaceholderString",
"short_code":"PlaceholderString",
"summary":"PlaceholderString",
"description":"PlaceholderString",
"charge":{
"currency":"EUR",
"amount":"10"
}
}]
}
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-50000: Unknown Error.
Create Branch
Create Branch for the Bank.
Authentication is Mandatory
OBP-20006: User is missing one or more roles: CanCreateBranch entitlements are required OR CanCreateBranchAtAnyBank
{
"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":"PDDL",
"name":"Open Data Commons Public Domain Dedication and 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",
"branch_type":"Full service store",
"more_info":"short walk to the lake from here",
"phone_number":"+381631954907"
}
-
CanCreateBranch
- Please login to request this Role
-
CanCreateBranchAtAnyBank
- Please login to request this Role
- 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.
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.
Authentication is Optional
{
"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":"PDDL",
"name":"Open Data Commons Public Domain Dedication and 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",
"branch_type":"Full service store",
"more_info":"short walk to the lake from here",
"phone_number":"+381631954907"
}
- OBP-20001: User not logged in. Authentication is required!
- License may not be set. meta.license.id and eta.license.name can not be empty
- OBP-50000: Unknown Error.
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, 100 records are returned.
You can use the url query parameters limit and offset for pagination
Authentication is Optional
{
"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":"PDDL",
"name":"Open Data Commons Public Domain Dedication and 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",
"branch_type":"Full service store",
"more_info":"short walk to the lake from here",
"phone_number":"+381631954907"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- No branches available. License may not be set.
- OBP-50000: Unknown Error.
Update Branch
Update an existing branch for a bank account (Authenticated access). Authentication is Mandatory
{
"id":"String",
"name":"String",
"address":{
"line_1":"Osloer Straße 16/17",
"line_2":"Wedding",
"line_3":"",
"city":"Berlin",
"state":"Berlin Brandenburg",
"postcode":"13359",
"country":"DE"
},
"location":{
"latitude":11.45,
"longitude":11.45
},
"lobby":{
"hours":"5"
},
"drive_up":{
"hours":"5"
},
"meta":{
"license":{
"id":"5",
"name":"TESOBE"
}
},
"branch_routing":{
"scheme":"String",
"address":"String"
}
}
-
CanCreateBranch
- Please login to request this Role
- 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-30209: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
- OBP-50000: Unknown Error.
Create Card
Create Card at bank specified by BANK_ID .
Authentication is Mandatory
{
"bank_id":"String",
"bank_card_number":"String",
"name_on_card":"String",
"issue_number":"String",
"serial_number":"String",
"valid_from_date":"2013-01-22T00:08:00Z",
"expires_date":"2013-01-22T00:08: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.uk.db"
},
"replacement":{
"requested_date":"2013-01-22T00:08:00Z",
"reason_requested":"Good Point"
},
"pin_reset":[{
"requested_date":"2013-01-22T00:08:00Z",
"reason_requested":"forgot"
}],
"collected":"2013-01-22T00:08:00Z",
"posted":"2013-01-22T00:08:00Z"
}
-
CanCreateCardsForBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
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.
{
"cards":[{
"bank_id":"String",
"bank_card_number":"String",
"name_on_card":"String",
"issue_number":"String",
"serial_number":"String",
"valid_from_date":"2013-01-22T00:08:00Z",
"expires_date":"2013-01-22T00:08: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.uk.db"
},
"replacement":{
"requested_date":"2013-01-22T00:08:00Z",
"reason_requested":"Good Point"
},
"pin_reset":[{
"requested_date":"2013-01-22T00:08:00Z",
"reason_requested":"forgot"
}],
"collected":"2013-01-22T00:08:00Z",
"posted":"2013-01-22T00:08:00Z"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get cards for the specified bank
{
"cards":[{
"bank_id":"String",
"bank_card_number":"String",
"name_on_card":"String",
"issue_number":"String",
"serial_number":"String",
"valid_from_date":"2013-01-22T00:08:00Z",
"expires_date":"2013-01-22T00:08: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.uk.db"
},
"replacement":{
"requested_date":"2013-01-22T00:08:00Z",
"reason_requested":"Good Point"
},
"pin_reset":[{
"requested_date":"2013-01-22T00:08:00Z",
"reason_requested":"forgot"
}],
"collected":"2013-01-22T00:08:00Z",
"posted":"2013-01-22T00:08:00Z"
}]
}
- 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.
Create counterparty for an account
Create counterparty.
Counterparties are created for the account / view They are how the user of the view (e.g. account owner) refers to the other side of the transaction
name is the human readable name (e.g. Piano teacher, Miss Nipa)
other_bank_id is an (internal) ID for the bank of the bank of the counterparty (if known)
other_account_id is an (internal) ID for the bank account of the counterparty (if known)
other_account_provider is a code that tells the system where that bank is hosted. Will be OBP if its known to the API. Usage of this flag (in API / connectors) is work in progress.
account_routing_scheme is a code that dictates the nature of the account_routing_address e.g. IBAN
account_routing_address is an instance of account_routing_scheme that can be used to route payments to external systems. e.g. an IBAN number
bank_routing_scheme is a code that dictates the nature of the bank_routing_address e.g. "BIC",
bank_routing_address is an instance of bank_routing_scheme
is_beneficiary must be set to true in order to send payments to this counterparty
The view specified by VIEW_ID must have the canAddCounterparty permission
Authentication is Mandatory
This endpoint works with firehose.
{
"name":"CounterpartyName",
"description":"My landlord",
"created_by_user_id":"49e1e147-64c1-4823-ad9f-89efcd02a9fa",
"this_bank_id":"gh.29.uk",
"this_account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"this_view_id":"owner",
"counterparty_id":"1d65db7c-a7b2-4839-af41-958276ab7790",
"other_bank_routing_scheme":"bankCode",
"other_bank_routing_address":"bankCode",
"other_branch_routing_scheme":"bankCode",
"other_branch_routing_address":"bankCode",
"other_account_routing_scheme":"bankCode",
"other_account_routing_address":"bankCode",
"other_account_secondary_routing_scheme":"bankCode",
"other_account_secondary_routing_address":"bankCode",
"is_beneficiary":true,
"bespoke":[{
"key":"englishName",
"value":"english Name"
}],
"metadata":{
"public_alias":"String",
"more_info":null,
"url":null,
"image_url":null,
"open_corporates_url":null,
"corporate_location":null,
"physical_location":null,
"private_alias":null
}
}
- OBP-20001: User not logged in. Authentication is required!
- 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-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-10001: Incorrect json format.
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME.
- OBP-50000: Unknown Error.
Get Counterparties of one Account.
Get the counterparties for the account / view.
Authentication is Mandatory
This endpoint works with firehose.
{
"counterparties":[{
"name":"CounterpartyName",
"description":"My landlord",
"created_by_user_id":"49e1e147-64c1-4823-ad9f-89efcd02a9fa",
"this_bank_id":"gh.29.uk",
"this_account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"this_view_id":"owner",
"counterparty_id":"1d65db7c-a7b2-4839-af41-958276ab7790",
"other_bank_routing_scheme":"bankCode",
"other_bank_routing_address":"bankCode",
"other_branch_routing_scheme":"bankCode",
"other_branch_routing_address":"bankCode",
"other_account_routing_scheme":"bankCode",
"other_account_routing_address":"bankCode",
"other_account_secondary_routing_scheme":"bankCode",
"other_account_secondary_routing_address":"bankCode",
"is_beneficiary":true,
"bespoke":[{
"key":"englishName",
"value":"english Name"
}]
}]
}
- 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-30005: View not found for Account. Please specify a valid value for VIEW_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.
Get Other Account by Id.
Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID. Authentication is Optional
Authentication is required if the view is not public.
{
"id":"String",
"holder":{
"name":"OBP",
"is_alias":true
},
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
},
"account_routing":{
"scheme":"IBAN",
"address":"DE89 3704 0044 0532 0130 00"
},
"metadata":{
"public_alias":"NONE",
"private_alias":"NONE",
"more_info":"www.openbankproject.com",
"url":"www.openbankproject.com",
"image_url":"www.openbankproject.com",
"open_corporates_url":"www.openbankproject.com",
"corporate_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
},
"physical_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}
}
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50000: Unknown Error.
Get Other Accounts of one Account.
Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID. Authentication is Optional
Authentication is required if the view VIEW_ID is not public.
{
"other_accounts":[{
"id":"String",
"holder":{
"name":"OBP",
"is_alias":true
},
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
},
"account_routing":{
"scheme":"IBAN",
"address":"DE89 3704 0044 0532 0130 00"
},
"metadata":{
"public_alias":"NONE",
"private_alias":"NONE",
"more_info":"www.openbankproject.com",
"url":"www.openbankproject.com",
"image_url":"www.openbankproject.com",
"open_corporates_url":"www.openbankproject.com",
"corporate_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
},
"physical_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}
}
}]
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50000: Unknown Error.
Add Corporate Location to Counterparty
Add the geolocation of the counterparty's registered address
{
"success":"Success"
}
- 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.
- the view does not allow metadata access
- the view does not allow adding a corporate location
- Coordinates not possible
- Corporate Location cannot be deleted
- OBP-50000: Unknown Error.
Add Counterparty More Info
Add a description of the counter party from the perpestive of the account e.g. My dentist.
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view ownerdoes not allow metadata access
- the view ownerdoes not allow adding more info
- More Info cannot be added
- OBP-50000: Unknown Error.
Add Open Corporates URL to Counterparty
Add open corporates url to other bank account.
{
"success":"Success"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding an open corporate url
- URL cannot be added
- OBP-50000: Unknown Error.
Add image url to other bank account.
Add a url that points to the logo of the counterparty
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding an image url
- URL cannot be added
- OBP-50000: Unknown Error.
Add physical location to other bank account.
Add geocoordinates of the counterparty's main location
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding a physical location
- Coordinates not possible
- Physical Location cannot be added
- OBP-50000: Unknown Error.
Add public alias to other bank account.
Creates the public alias for the other account OTHER_ACCOUNT_ID.
Authentication is Optional Authentication is required if the view is not public.
Note: Public aliases are automatically generated for new 'other accounts / counterparties', so this call should only be used if the public alias was deleted.
The VIEW_ID parameter should be a view the caller is permitted to access to and that has permission to create public aliases.
{
"success":"Success"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- the view does not allow metadata access
- the view does not allow adding a public alias
- Alias cannot be added
- public alias added
Add url to other bank account.
A url which represents the counterparty (home page url etc.)
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding a url
- URL cannot be added
- OBP-50000: Unknown Error.
Create Other Account Private Alias
Creates a private alias for the other account OTHER_ACCOUNT_ID.
Authentication is Optional Authentication is required if the view is not public.
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding a private alias
- Alias cannot be added
- OBP-50000: Unknown Error.
Delete Counterparty Corporate Location.
Delete corporate location of other bank account. Delete the geolocation of the counterparty's registered address
{
}
- 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.
- the view does not allow metadata access
- Corporate Location cannot be deleted
- Delete not completed
- OBP-50000: Unknown Error.
Delete Counterparty Image URL
Delete image url of other bank account.
{
}
- OBP-50000: Unknown Error.
Delete Counterparty Open Corporates URL
Delete open corporate url of other bank account.
{
}
- 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.
- the view does not allow metadata access
- the view does not allow deleting an open corporate url
- URL cannot be deleted
- OBP-50000: Unknown Error.
Delete Counterparty Physical Location.
Delete physical location of other bank account.
{
}
- 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.
- the view ownerdoes not allow metadata access
- Physical Location cannot be deleted
- Delete not completed
- OBP-50000: Unknown Error.
Delete Counterparty Private Alias
Deletes the private alias of the other account OTHER_ACCOUNT_ID.
Authentication is Optional Authentication is required if the view is not public.
{
}
- 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.
- the view does not allow metadata access
- the view does not allow deleting the private alias
- Alias cannot be deleted
- OBP-50000: Unknown Error.
Delete Counterparty Public Alias
Deletes the public alias of the other account OTHER_ACCOUNT_ID.
Authentication is Optional Authentication is required if the view is not public.
{
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- the view does not allow metadata access
- the view does not allow deleting the public alias
- Alias cannot be deleted
- OBP-50000: Unknown Error.
Delete more info of other bank account.
{
}
- 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.
- the view does not allow metadata access
- the view does not allow deleting more info
- More Info cannot be deleted
- OBP-50000: Unknown Error.
Delete url of other bank account.
{
}
- 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.
- the view does not allow metadata access
- the view does not allow deleting a url
- URL cannot be deleted
- OBP-50000: Unknown Error.
Get Other Account Metadata.
Get metadata of one other account. Returns only the metadata about one other bank account (OTHER_ACCOUNT_ID) that had shared at least one transaction with ACCOUNT_ID at BANK_ID.
Authentication via OAuth is required if the view is not public.
{
"public_alias":"NONE",
"private_alias":"NONE",
"more_info":"www.openbankproject.com",
"url":"www.openbankproject.com",
"image_url":"www.openbankproject.com",
"open_corporates_url":"www.openbankproject.com",
"corporate_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
},
"physical_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
- the view does not allow metadata access
Get Other Account Private Alias
Returns the private alias of the other account OTHER_ACCOUNT_ID.
Authentication is Optional Authentication is required if the view is not public.
{
"alias":"String"
}
- 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.
- the view does not allow metadata access
- the view does not allow private alias access
- OBP-50000: Unknown Error.
Get public alias of other bank account.
Returns the public alias of the other account OTHER_ACCOUNT_ID. Authentication is Optional OAuth authentication is required if the view is not public.
{
"alias":"String"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50000: Unknown Error.
- the view does not allow metadata access
- the view does not allow public alias access
Update Counterparty Corporate Location
Update the geolocation of the counterparty's registered address
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating a corporate location
- Coordinates not possible
- Corporate Location cannot be updated
- OBP-50000: Unknown Error.
Update Counterparty Image Url
Update the url that points to the logo of the counterparty
{
"success":"Success"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating an image url
- URL cannot be updated
- OBP-50000: Unknown Error.
Update Counterparty More Info
Update the more info description of the counter party from the perpestive of the account e.g. My dentist.
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating more info
- More Info cannot be updated
- OBP-50000: Unknown Error.
Update Counterparty Physical Location
Update geocoordinates of the counterparty's main location
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating a physical location
- Coordinates not possible
- Physical Location cannot be updated
- OBP-50000: Unknown Error.
Update Counterparty Private Alias
Updates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID.
Authentication is Optional Authentication is required if the view is not public.
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating the private alias
- Alias cannot be updated
- OBP-50000: Unknown Error.
Update Open Corporates Url of Counterparty
Update open corporate url of other bank account.
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating an open corporate url
- URL cannot be updated
- OBP-50000: Unknown Error.
Update public alias of other bank account.
Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID.
Authentication is Optional Authentication is required if the view is not public.
{
"success":"Success"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- OBP-20001: User not logged in. Authentication is required!
- the view does not allow metadata access
- the view does not allow updating the public alias
- Alias cannot be updated
- OBP-50000: Unknown Error.
Update url of other bank account.
A url which represents the counterparty (home page url etc.)
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view ownerdoes not allow metadata access
- the view ownerdoes not allow updating a url
- URL cannot be updated
- OBP-50000: Unknown Error.
Add Social Media Handle
Add a social media handle for the customer specified by CUSTOMER_ID.
{
"success":"Success"
}
-
CanAddSocialMediaHandle
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- 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-20006: User is missing one or more roles:
- OBP-30002: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Create Customer.
Add a customer linked to the user specified by user_id The Customer resource stores the customer number, legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc. Dates need to be in the format 2013-01-21T23:08:00Z
Authentication is Mandatory
CanCreateCustomer and CanCreateUserCustomerLink OR CanCreateCustomerAtAnyBank and CanCreateUserCustomerLinkAtAnyBank entitlements required.
{
"bank_id":"bankid1234",
"customer_id":"123",
"customer_number":"123",
"legal_name":"legal_name",
"mobile_phone_number":"123",
"email":"contact@tesobe.com",
"face_image":{
"url":"www.openbankproject",
"date":"2013-01-22T00:08:00Z"
},
"date_of_birth":"2013-01-22T00:08:00Z",
"relationship_status":"123",
"dependants":123,
"dob_of_dependants":["2013-01-22T00:08:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"10"
},
"highest_education_attained":"123",
"employment_status":"123",
"kyc_status":true,
"last_ok_date":"2013-01-22T00:08:00Z"
}
-
CanCreateCustomer
- Please login to request this Role
-
CanCreateUserCustomerLink
- Please login to request this Role
-
CanCreateCustomerAtAnyBank
- Please login to request this Role
-
CanCreateUserCustomerLinkAtAnyBank
- Please login to request this Role
- 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-30006: Customer Number already exists. Please specify a different value for BANK_ID or CUSTOMER_NUMBER.
- OBP-20005: User not found. Please specify a valid value for USER_ID.
- OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID
- OBP-30024: Could not create Consumer
- OBP-50000: Unknown Error.
Create User Customer Link.
Link a User to a Customer
Authentication is Mandatory
CanCreateUserCustomerLink OR CanCreateUserCustomerLinkAtAnyBank entitlements are required.
{
"user_customer_link_id":"String",
"customer_id":"String",
"user_id":"String",
"date_inserted":"2013-01-22T00:08:00Z",
"is_active":true
}
-
CanCreateUserCustomerLink
- Please login to request this Role
-
CanCreateUserCustomerLinkAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- 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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-10001: Incorrect json format.
- OBP-30002: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-20006: User is missing one or more roles:
- OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID
- OBP-30025: Could not create user_customer_links
- OBP-50000: Unknown Error.
Get CRM Events
{
"crm_events":[{
"id":"String",
"bank_id":"String",
"customer_name":"String",
"customer_number":"String",
"category":"String",
"detail":"String",
"channel":"String",
"scheduled_date":"2013-01-22T00:08:00Z",
"actual_date":"2013-01-22T00:08:00Z",
"result":"String"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- No CRM Events available.
- OBP-50000: Unknown Error.
Get Customer Social Media Handles
Get social media handles for a customer specified by CUSTOMER_ID.
Authentication is Mandatory
{
"checks":[{
"customer_number":"PlaceholderString",
"type":"PlaceholderString",
"handle":"PlaceholderString",
"date_added":"2013-01-22T00:08:00Z",
"date_activated":"2013-01-22T00:08:00Z"
}]
}
-
CanGetSocialMediaHandles
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-30002: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Get Customers for Current User
Gets all Customers that are linked to a User.
Authentication is Mandatory
{
"bank_id":"bankid1234",
"customer_id":"123",
"customer_number":"123",
"legal_name":"legal_name",
"mobile_phone_number":"123",
"email":"contact@tesobe.com",
"face_image":{
"url":"www.openbankproject",
"date":"2013-01-22T00:08:00Z"
},
"date_of_birth":"2013-01-22T00:08:00Z",
"relationship_status":"123",
"dependants":123,
"dob_of_dependants":["2013-01-22T00:08:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"10"
},
"highest_education_attained":"123",
"employment_status":"123",
"kyc_status":true,
"last_ok_date":"2013-01-22T00:08:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30008: User Customer Link not found by USER_ID
- OBP-50000: Unknown Error.
Get Customers for current User at Bank
Retuns a list of Customers at the Bank that are linked to the currently authenticated User.
Authentication is Mandatory
{
"bank_id":"bankid1234",
"customer_id":"123",
"customer_number":"123",
"legal_name":"legal_name",
"mobile_phone_number":"123",
"email":"contact@tesobe.com",
"face_image":{
"url":"www.openbankproject",
"date":"2013-01-22T00:08:00Z"
},
"date_of_birth":"2013-01-22T00:08:00Z",
"relationship_status":"123",
"dependants":123,
"dob_of_dependants":["2013-01-22T00:08:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"10"
},
"highest_education_attained":"123",
"employment_status":"123",
"kyc_status":true,
"last_ok_date":"2013-01-22T00:08:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30008: User Customer Link not found by USER_ID
- OBP-30008: User Customer Link not found by USER_ID
- OBP-30002: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Search Warehouse Data Via Elasticsearch
Search warehouse data via Elastic Search.
Authentication is Mandatory
CanSearchWarehouse entitlement is required to search warehouse data!
Send your email, name, project name and user_id to the admins to get access.
Elastic (search) is used in the background. See links below for syntax.
This version differs from v2.0.0
Example of usage:
POST /search/warehouse
{ "es_uri_part": "/THE_INDEX_YOU_WANT_TO_USE/_search?pretty=true", "es_body_part": { "query": { "range": { "postDate": { "from": "2011-12-10", "to": "2011-12-12" } } } } }
Elastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-uri-request.html
Elastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/5.3/query-filter-context.html
Elastic aggregations: https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-aggregations.html
{
}
-
CanSearchWarehouse
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Create Fx
Create or Update Fx for the Bank.
Authentication is Mandatory
OBP-20006: User is missing one or more roles: CanCreateFxRate OR CanCreateFxRateAtAnyBank
{
"bank_id":"bankid123",
"from_currency_code":"EUR",
"to_currency_code":"USD",
"conversion_value":1.0,
"inverse_conversion_value":1.0,
"effective_date":"2013-01-22T00:08:00Z"
}
-
CanCreateFxRate
- Please login to request this Role
-
CanCreateFxRateAtAnyBank
- Please login to request this Role
- 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.
Get Current FxRate
Get the latest FXRate specified by BANK_ID, FROM_CURRENCY_CODE and TO_CURRENCY_CODE
{
"bank_id":"bankid434",
"from_currency_code":"EUR",
"to_currency_code":"GBP",
"conversion_value":1.001,
"inverse_conversion_value":0.998,
"effective_date":"2013-01-22T00:08:00Z"
}
- OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
- OBP-20001: User not logged in. Authentication is required!
- OBP-10004: ISO Currency code combination not supported for FX. Please modify the FROM_CURRENCY_CODE or TO_CURRENCY_CODE.
- OBP-50000: Unknown Error.
Add KYC Check
Add a KYC check for the customer specified by CUSTOMER_ID. KYC Checks store details of checks on a customer made by the KYC team, their comments and a satisfied status.
{
"bank_id":"PlaceholderString",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"PlaceholderString",
"date":"2013-01-22T00:08:00Z",
"how":"PlaceholderString",
"staff_user_id":"PlaceholderString",
"staff_name":"PlaceholderString",
"satisfied":true,
"comments":"PlaceholderString"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- 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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30002: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-00004: Server error: could not add message
- OBP-50000: Unknown Error.
Add KYC Document.
Add a KYC document for the customer specified by CUSTOMER_ID. KYC Documents contain the document type (e.g. passport), place of issue, expiry etc.
{
"bank_id":"PlaceholderString",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"PlaceholderString",
"type":"PlaceholderString",
"number":"PlaceholderString",
"issue_date":"2013-01-22T00:08:00Z",
"issue_place":"PlaceholderString",
"expiry_date":"2013-01-22T00:08:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- 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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30002: Customer not found. Please specify a valid value for CUSTOMER_ID.
- Server error: could not add KycDocument
- OBP-50000: Unknown Error.
Add KYC Media.
Add some KYC media for the customer specified by CUSTOMER_ID. KYC Media resources relate to KYC Documents and KYC Checks and contain media urls for scans of passports, utility bills etc.
{
"bank_id":"PlaceholderString",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"PlaceholderString",
"type":"PlaceholderString",
"url":"PlaceholderString",
"date":"2013-01-22T00:08:00Z",
"relates_to_kyc_document_id":"PlaceholderString",
"relates_to_kyc_check_id":"PlaceholderString"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- 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-30002: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-00004: Server error: could not add message
- OBP-50000: Unknown Error.
Add KYC Status
Add a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer
{
"customer_id":"PlaceholderString",
"customer_number":"PlaceholderString",
"ok":true,
"date":"2013-01-22T00:08:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- 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-50000: Unknown Error.
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-00004: Server error: could not add message
- OBP-30002: Customer not found. Please specify a valid value for CUSTOMER_ID.
Get Customer KYC Checks
Get KYC checks for the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
{
"checks":[{
"bank_id":"PlaceholderString",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"PlaceholderString",
"date":"2013-01-22T00:08:00Z",
"how":"PlaceholderString",
"staff_user_id":"PlaceholderString",
"staff_name":"PlaceholderString",
"satisfied":true,
"comments":"PlaceholderString"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30002: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Get Customer KYC Documents
Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID Get a list of documents that affirm the identity of the customer Passport, driving licence etc. Authentication is Optional
{
"documents":[{
"bank_id":"PlaceholderString",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"PlaceholderString",
"type":"PlaceholderString",
"number":"PlaceholderString",
"issue_date":"2013-01-22T00:08:00Z",
"issue_place":"PlaceholderString",
"expiry_date":"2013-01-22T00:08:00Z"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30002: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Get Customer KYC statuses
Get the KYC statuses for a customer specified by CUSTOMER_ID over time.
Authentication is Mandatory
{
"statuses":[{
"customer_id":"PlaceholderString",
"customer_number":"PlaceholderString",
"ok":true,
"date":"2013-01-22T00:08:00Z"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30002: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Get KYC Media for a customer
Get KYC media (scans, pictures, videos) that affirms the identity of the customer.
Authentication is Mandatory
{
"medias":[{
"bank_id":"PlaceholderString",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"PlaceholderString",
"type":"PlaceholderString",
"url":"PlaceholderString",
"date":"2013-01-22T00:08:00Z",
"relates_to_kyc_document_id":"PlaceholderString",
"relates_to_kyc_check_id":"PlaceholderString"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30002: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Create Meeting (video conference/call)
Create Meeting: Initiate a video conference/call with the bank.
The Meetings resource contains meta data about video/other conference sessions, not the video/audio/chat itself.
The actual conferencing is handled by external providers. Currently OBP supports tokbox video conferences (WIP).
This is not a recomendation of tokbox per se.
provider_id determines the provider of the meeting / video chat service. MUST be url friendly (no spaces).
purpose_id explains the purpose of the chat. onboarding | mortgage | complaint etc. MUST be url friendly (no spaces).
Login is required.
This call is experimental. Currently staff_user_id is not set. Further calls will be needed to correctly set this.
{
"meeting_id":"String",
"provider_id":"String",
"purpose_id":"String",
"bank_id":"String",
"present":{
"staff_user_id":"String",
"customer_user_id":"String"
},
"keys":{
"session_id":"String",
"staff_token":"String",
"customer_token":"String"
},
"when":"2013-01-22T00:08:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30102: Meeting provider API Key is not configured.
- OBP-30103: Meeting provider Secret is not configured.
- 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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-10001: Incorrect json format.
- OBP-30101: Meetings are not supported on this server.
- OBP-50000: Unknown Error.
Get Meeting
Get Meeting specified by BANK_ID / MEETING_ID Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.
The actual conference/chats are handled by external services.
Login is required.
This call is experimental and will require further authorisation in the future.
{
"meeting_id":"String",
"provider_id":"String",
"purpose_id":"String",
"bank_id":"String",
"present":{
"staff_user_id":"String",
"customer_user_id":"String"
},
"keys":{
"session_id":"String",
"staff_token":"String",
"customer_token":"String"
},
"when":"2013-01-22T00:08:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30102: Meeting provider API Key is not configured.
- OBP-30103: Meeting provider Secret is not configured.
- OBP-30104: Meeting not found.
- OBP-30101: Meetings are not supported on this server.
- OBP-50000: Unknown Error.
Get Meetings
Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.
The actual conference/chats are handled by external services.
Login is required.
This call is experimental and will require further authorisation in the future.
{
"meetings":[{
"meeting_id":"String",
"provider_id":"String",
"purpose_id":"String",
"bank_id":"String",
"present":{
"staff_user_id":"String",
"customer_user_id":"String"
},
"keys":{
"session_id":"String",
"staff_token":"String",
"customer_token":"String"
},
"when":"2013-01-22T00:08:00Z"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30102: Meeting provider API Key is not configured.
- OBP-30103: Meeting provider Secret is not configured.
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30101: Meetings are not supported on this server.
- OBP-50000: Unknown Error.
Add Customer Message.
Add a message for the customer specified by CUSTOMER_ID
{
"success":"Success"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Customer Messages (current)
Get messages for the logged in customer Messages sent to the currently authenticated user.
Authentication via OAuth is required.
{
"messages":[{
"id":"String",
"date":"2013-01-22T00:08:00Z",
"message":"String",
"from_department":"String",
"from_person":"String"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Create Product
Create or Update Product for the Bank.
Authentication is Mandatory
OBP-20006: User is missing one or more roles: CanCreateProduct OR CanCreateProductAtAnyBank
{
"bank_id":"bankid123",
"code":"prod1",
"name":"product name",
"category":"category",
"family":"family",
"super_family":"super family",
"more_info_url":"www.example.com/prod1/more-info.html",
"details":"Details",
"description":"Description",
"meta":{
"license":{
"id":"5",
"name":"TESOBE"
}
}
}
-
CanCreateProduct
- Please login to request this Role
-
CanCreateProductAtAnyBank
- Please login to request this Role
- 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.
Get Bank Product
Returns information about the financial products offered by a bank specified by BANK_ID and PRODUCT_CODE including:
- Name
- Code
- Category
- Family
- Super Family
- More info URL
- Description
- Terms and Conditions
- License the data under this endpoint is released under Authentication is Optional
{
"bank_id":"bankid123",
"code":"prod1",
"name":"product name",
"category":"category",
"family":"family",
"super_family":"super family",
"more_info_url":"www.example.com/prod1/more-info.html",
"details":"Details",
"description":"Description",
"meta":{
"license":{
"id":"5",
"name":"TESOBE"
}
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.
- OBP-50000: Unknown Error.
Get Bank Products
Returns information about the financial products offered by a bank specified by BANK_ID including:
- Name
- Code
- Category
- Family
- Super Family
- More info URL
- Description
- Terms and Conditions
- License the data under this endpoint is released under Authentication is Optional
{
"products":[{
"bank_id":"bankid123",
"code":"prod1",
"name":"product name",
"category":"category",
"family":"family",
"super_family":"super family",
"more_info_url":"www.example.com/prod1/more-info.html",
"details":"Details",
"description":"Description",
"meta":{
"license":{
"id":"5",
"name":"TESOBE"
}
}
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.
- OBP-50000: Unknown Error.
Add Entitlement Request for a Logged User.
Create Entitlement Request.
Any logged in User can use this endpoint to request an Entitlement
Entitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
Authentication is Mandatory
{
"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"user":{
"user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"email":"robert.x.0.gh@example.com",
"provider_id":"OBP",
"provider":"OBP",
"username":"robert.x.0.gh",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
},
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk",
"created":"2013-01-22T00:08:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20005: User not found. Please specify a valid value for USER_ID.
- OBP-10001: Incorrect json format.
- OBP-10007: Incorrect Role name:
- OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
- OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
- OBP-30214: Entitlement Request already exists for the user.
- OBP-30214: Entitlement Request cannot be added.
- OBP-50000: Unknown Error.
Add Entitlement for a User.
Create Entitlement. Grant Role to User.
Entitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
Authentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.
{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}
-
CanCreateEntitlementAtOneBank
- Please login to request this Role
-
CanCreateEntitlementAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20005: User not found. Please specify a valid value for USER_ID.
- OBP-10001: Incorrect json format.
- OBP-10007: Incorrect Role name:
- OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
- OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
- OBP-30216: Entitlement already exists for the user.
- OBP-50000: Unknown Error.
Delete Entitlement
Delete Entitlement specified by ENTITLEMENT_ID for an user specified by USER_ID
Authentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.
{
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-30212: EntitlementId not found
- OBP-50000: Unknown Error.
Delete Entitlement Request
Delete the Entitlement Request specified by ENTITLEMENT_REQUEST_ID for a user specified by USER_ID
Authentication is Mandatory
{
}
-
CanDeleteEntitlementRequestsAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
Get Entitlement Requests for a User.
Get Entitlement Requests for a User.
Authentication is Mandatory
{
"entitlement_requests":[{
"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"user":{
"user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"email":"robert.x.0.gh@example.com",
"provider_id":"OBP",
"provider":"OBP",
"username":"robert.x.0.gh",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
},
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk",
"created":"2013-01-22T00:08:00Z"
}]
}
-
CanGetEntitlementRequestsAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
Get Entitlement Requests for the current User.
Get Entitlement Requests for the current User.
Authentication is Mandatory
{
"entitlement_requests":[{
"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"user":{
"user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"email":"robert.x.0.gh@example.com",
"provider_id":"OBP",
"provider":"OBP",
"username":"robert.x.0.gh",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
},
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk",
"created":"2013-01-22T00:08:00Z"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
Get Entitlements for User
Authentication is Mandatory
{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
-
CanGetEntitlementsForAnyUserAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Entitlements for User at Bank.
Get Entitlements specified by BANK_ID and USER_ID
Authentication is Mandatory
{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
-
CanGetEntitlementsForAnyUserAtOneBank
- Please login to request this Role
-
CanGetEntitlementsForAnyUserAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Entitlements for the current User.
Get Entitlements for the current User.
Authentication is Mandatory
{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
Get Roles
Returns all available roles
Authentication is Mandatory
{
"roles":[{
"role":"eBranch",
"requires_bank_id":true
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get all Entitlement Requests
Get all Entitlement Requests
Authentication is Mandatory
{
"entitlement_requests":[{
"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"user":{
"user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"email":"robert.x.0.gh@example.com",
"provider_id":"OBP",
"provider":"OBP",
"username":"robert.x.0.gh",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
},
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk",
"created":"2013-01-22T00:08:00Z"
}]
}
-
CanGetEntitlementRequestsAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
Get all Entitlements
Login is required.
{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-50000: Unknown Error.
Get Other Account of Transaction
Get other account of a transaction. Returns details of the other party involved in the transaction, moderated by the view (VIEW_ID). Authentication via OAuth is required if the view is not public.
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"holder":{
"name":"OBP",
"is_alias":true
},
"number":"123",
"kind":"3456",
"iban":"UK234DB",
"swift_bic":"UK12321DB",
"bank":{
"national_identifier":"OBP",
"name":"OBP"
},
"metadata":{
"public_alias":"NONE",
"private_alias":"NONE",
"more_info":"www.openbankproject.com",
"url":"www.openbankproject.com",
"image_url":"www.openbankproject.com",
"open_corporates_url":"www.openbankproject.com",
"corporate_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
},
"physical_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}
}
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50000: Unknown Error.
Get Transaction by Id.
Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and moderated by the view (VIEW_ID).
Authentication is Optional Authentication is required if the view is not public.
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"this_account":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"holders":[{
"name":"OBP",
"is_alias":true
}],
"number":"123",
"kind":"AC",
"iban":"UK1234AD",
"swift_bic":"UK1234AD",
"bank":{
"national_identifier":"OBP",
"name":"OBP"
}
},
"other_account":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"holder":{
"name":"OBP",
"is_alias":true
},
"number":"123",
"kind":"3456",
"iban":"UK234DB",
"swift_bic":"UK12321DB",
"bank":{
"national_identifier":"OBP",
"name":"OBP"
},
"metadata":{
"public_alias":"NONE",
"private_alias":"NONE",
"more_info":"www.openbankproject.com",
"url":"www.openbankproject.com",
"image_url":"www.openbankproject.com",
"open_corporates_url":"www.openbankproject.com",
"corporate_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
},
"physical_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}
}
},
"details":{
"type":"AC",
"description":"GOOD",
"posted":"2013-01-22T00:08:00Z",
"completed":"2013-01-22T00:08:00Z",
"new_balance":{
"currency":"EUR",
"amount":"10"
},
"value":{
"currency":"EUR",
"amount":"10"
}
},
"metadata":{
"narrative":"NONE",
"comments":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}],
"tags":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}],
"images":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"NONE",
"url":"www.openbankproject.com",
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}],
"where":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}
}
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50000: Unknown Error.
Get Transactions for Account (Core)
Returns transactions list (Core info) of the account specified by ACCOUNT_ID.
Authentication is Mandatory
Possible custom headers for pagination:
- obp_sort_direction=ASC/DESC ==> default value: DESC. The sort field is the completed date.
- obp_limit=NUMBER ==> default value: 50
- obp_offset=NUMBER ==> default value: 0
- obp_from_date=DATE => default value: Thu Jan 01 01:00:00 CET 1970 (format below)
- obp_to_date=DATE => default value: 3049-01-01
Date format parameter: "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" (2014-07-01T00:00:00.000Z) ==> time zone is UTC.
{
"transactions":[{
"id":"String",
"this_account":{
"id":"String",
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
},
"account_routing":{
"scheme":"IBAN",
"address":"DE89 3704 0044 0532 0130 00"
},
"holders":[{
"name":"OBP",
"is_alias":true
}]
},
"other_account":{
"id":"String",
"holder":{
"name":"OBP",
"is_alias":true
},
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
},
"account_routing":{
"scheme":"IBAN",
"address":"DE89 3704 0044 0532 0130 00"
}
},
"details":{
"type":"AC",
"description":"OBP",
"posted":"2013-01-22T00:08:00Z",
"completed":"2013-01-22T00:08:00Z",
"new_balance":{
"currency":"EUR",
"amount":"10"
},
"value":{
"currency":"EUR",
"amount":"10"
}
}
}]
}
- OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!
- OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)!
- OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)!
- OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' or that one yyyy-MM-dd'T'HH:mm:ss.SSSZ!
- 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-50000: Unknown Error.
Get Transactions for Account (Full)
Returns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID).
Authentication is Optional
Authentication is required if the view is not public.
Possible custom headers for pagination:
- obp_sort_direction=ASC/DESC ==> default value: DESC. The sort field is the completed date.
- obp_limit=NUMBER ==> default value: 50
- obp_offset=NUMBER ==> default value: 0
- obp_from_date=DATE => default value: date of the oldest transaction registered (format below)
- obp_to_date=DATE => default value: 3049-01-01
Date format parameter: "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" (2014-07-01T00:00:00.000Z) ==> time zone is UTC.
{
"transactions":[{
"id":"String",
"this_account":{
"id":"String",
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
},
"account_routing":{
"scheme":"IBAN",
"address":"DE89 3704 0044 0532 0130 00"
},
"holders":[{
"name":"OBP",
"is_alias":true
}]
},
"other_account":{
"id":"String",
"holder":{
"name":"OBP",
"is_alias":true
},
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
},
"account_routing":{
"scheme":"IBAN",
"address":"DE89 3704 0044 0532 0130 00"
},
"metadata":{
"public_alias":"NONE",
"private_alias":"NONE",
"more_info":"www.openbankproject.com",
"url":"www.openbankproject.com",
"image_url":"www.openbankproject.com",
"open_corporates_url":"www.openbankproject.com",
"corporate_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
},
"physical_location":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}
}
},
"details":{
"type":"AC",
"description":"GOOD",
"posted":"2013-01-22T00:08:00Z",
"completed":"2013-01-22T00:08:00Z",
"new_balance":{
"currency":"EUR",
"amount":"10"
},
"value":{
"currency":"EUR",
"amount":"10"
}
},
"metadata":{
"narrative":"NONE",
"comments":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}],
"tags":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}],
"images":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"NONE",
"url":"www.openbankproject.com",
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}],
"where":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}
}
}]
}
- OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!
- OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)!
- OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)!
- OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' or that one yyyy-MM-dd'T'HH:mm:ss.SSSZ!
- 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-50000: Unknown Error.
Add a tag.
Posts a tag about a transaction TRANSACTION_ID on a view VIEW_ID.
Authentication is Mandatory
Authentication is required as the tag is linked with the user.
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}
- 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.
- view owner does not authorize metadata access
- view owner does not authorize adding tags
- OBP-50000: Unknown Error.
Add an image.
Posts an image about a transaction TRANSACTION_ID on a view VIEW_ID.
Authentication is Mandatory
The image is linked with the user.
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"NONE",
"url":"www.openbankproject.com",
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}
- OBP-10001: Incorrect json format.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- view does not authorize metadata access
- view does not authorize adding images
- Could not parse url string as a valid URL
- OBP-50000: Unknown Error.
Add comment.
Posts a comment about a transaction TRANSACTION_ID on a view VIEW_ID.
${authenticationRequiredMessage(false)}
Authentication is required since the comment is linked with the user.
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- view owner does not authorize metadata access
- view owner does not authorize adding comments
- OBP-50000: Unknown Error.
Add narrative.
Creates a description of the transaction TRANSACTION_ID.
Note: Unlike other items of metadata, there is only one "narrative" per transaction accross all views. If you set narrative via a view e.g. view-x it will be seen via view-y (as long as view-y has permission to see the narrative).
Authentication is Optional Authentication is required if the view is not public.
{
"success":"Success"
}
- OBP-10001: Incorrect json format.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- view does not authorize metadata access
- view does not authorize narrative access
- view does not allow adding a narrative
- OBP-50000: Unknown Error.
Add where tag.
Creates a "where" Geo tag on a transaction TRANSACTION_ID in a view.
Authentication is Mandatory
The geo tag is linked with the user.
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- view does not authorize metadata access
- the view does not allow adding a where tag
- Coordinates not possible
- OBP-50000: Unknown Error.
Delete a tag.
Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on view.
Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the tag.
{
}
- OBP-50000: Unknown Error.
Delete an image
Deletes the image IMAGE_ID about the transaction TRANSACTION_ID made on view.
Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.
{
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- view does not authorize metadata access
- User must be logged in
- You must be able to see images in order to delete them
- Image not found for this transaction
- Deleting images not permitted for this view
- Deleting images not permitted for the current user
- OBP-50000: Unknown Error.
Delete comment.
Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on view.
Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.
{
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- view owner does not authorize metadata access
- User must be logged in
- You must be able to see comments in order to delete them
- Comment not found for this transaction
- Deleting comments not permitted for this view
- Deleting comments not permitted for the current user
- OBP-50000: Unknown Error.
Delete narrative.
Deletes the description of the transaction TRANSACTION_ID.
Authentication via OAuth is required if the view is not public.
{
}
- 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.
- view does not authorize metadata access
- view does not allow deleting the narrative
- OBP-50000: Unknown Error.
Delete where tag.
Deletes the where tag of the transaction TRANSACTION_ID made on view.
Authentication is Mandatory
The user must either have owner privileges for this account, or must be the user that posted the geo tag.
{
}
- 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.
- view does not authorize metadata access
- User must be logged in
- You must be able to see the where tag in order to delete it
- there is no tag to delete
- Deleting tag is not permitted for this view
- Deleting tags not permitted for the current user
- Delete not completed
- OBP-50000: Unknown Error.
Get comments.
Returns the transaction TRANSACTION_ID comments made on a view (VIEW_ID).
Authentication via OAuth is required if the view is not public.
{
"comments":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}]
}
- 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.
- view does not authorize metadata access
- view does not authorize comments access
- OBP-50000: Unknown Error.
Get images.
Returns the transaction TRANSACTION_ID images made on a view (VIEW_ID). Authentication via OAuth is required if the view is not public.
{
"images":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"NONE",
"url":"www.openbankproject.com",
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}]
}
- 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.
- view does not authorize metadata access
- view does not authorize images access
- OBP-50000: Unknown Error.
Get narrative.
Returns the account owner description of the transaction moderated by the view.
Authentication via OAuth is required if the view is not public.
{
"narrative":"narative"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- view does not authorize metadata access
- view does not authorize narrative access
- OBP-50000: Unknown Error.
Get tags.
Returns the transaction TRANSACTION_ID tags made on a view (VIEW_ID). Authentication via OAuth is required if the view is not public.
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- view does not authorize metadata access
- view does not authorize tag access
- OBP-50000: Unknown Error.
Get where tag.
Returns the "where" Geo tag added to the transaction TRANSACTION_ID made on a view (VIEW_ID). It represents the location where the transaction has been initiated.
Authentication via OAuth is required if the view is not public.
{
"where":{
"latitude":1.231,
"longitude":1.231,
"date":"2013-01-22T00:08:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"OBP",
"display_name":"OBP"
}
}
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- view does not authorize metadata access
- view does not authorize where tag access
- OBP-50000: Unknown Error.
Update narrative.
Updates the description of the transaction TRANSACTION_ID.
Authentication via OAuth is required if the view is not public.
{
"success":"Success"
}
- OBP-10001: Incorrect json format.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- view does not authorize metadata access
- view does not allow updating a narrative
- OBP-50000: Unknown Error.
Update where tag.
Updates the "where" Geo tag on a transaction TRANSACTION_ID in a view.
Authentication is Mandatory
The geo tag is linked with the user.
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- view does not authorize metadata access
- the view does not allow updating a where tag
- Coordinates not possible
- OBP-50000: Unknown Error.
Answer Transaction Request Challenge.
In Sandbox mode, any string that can be converted to a positive integer will be accepted as an answer.
This endpoint totally depends on createTransactionRequest, it need get the following data from createTransactionRequest response body.
1)TRANSACTION_REQUEST_TYPE
: is the same as createTransactionRequest request URL .
2)TRANSACTION_REQUEST_ID
: is the id
field in createTransactionRequest response body.
3) id
: is challenge.id
field in createTransactionRequest response body.
4) answer
: is challenge.answer
can be any Interge in sandbox mode.
This endpoint works with firehose.
{
"id":"82f92531-9c63-4246-abfc-96c20ec46188",
"type":"SANDBOX_TAN",
"from":{
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"
},
"details":{
},
"transaction_ids":"666666-9c63-4246-abfc-96c20ec46188",
"status":"COMPLETED",
"start_date":"2013-01-22T00:08:00Z",
"end_date":"2013-01-22T00:08:00Z",
"challenge":{
"id":"be1a183d-b301-4b83-b855-5eeffdd3526f",
"allowed_attempts":3,
"challenge_type":"SANDBOX_TAN"
},
"charge":{
"summary":"Good",
"value":{
"currency":"EUR",
"amount":"10"
}
}
}
- OBP-20001: User not logged in. Authentication is required!
- 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-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
- OBP-10001: Incorrect json format.
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-40011: Transaction Request Status is not INITIATED.
- OBP-40009: The TRANSACTION_REQUEST_TYPE has changed.
- OBP-40010: Invalid Challenge Id. Please specify a valid value for CHALLENGE_ID.
- OBP-40014: Sorry, you've used up your allowed attempts.
- OBP-00003: Transaction Requests is disabled in this API instance.
- OBP-50000: Unknown Error.
Create Transaction Request (COUNTERPARTY)
Special instructions for COUNTERPARTY:
When using a COUNTERPARTY to create a Transaction Request, specificy the counterparty_id in the body of the request. The routing details of the counterparty will be forwarded for the transfer.
Initiate a Payment via creating a Transaction Request.
In OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
Transaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response. This provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
In sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.
In sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
If a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
You can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
The following static FX rates are available in sandbox mode:
{ "XAF":{ "AUD":1.0, "KRW":1.87975, "JOD":1.0, "GBP":0.00131092, "AED":0.00601555, "INR":0.110241, "JPY":0.185328, "USD":0.00163773, "EUR":0.00152449 }, "AUD":{ "XAF":762.826, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":0.79, "EUR":0.67 }, "KRW":{ "XAF":0.531986, "AUD":1.0, "JOD":1.0, "GBP":6.97389E-4, "AED":0.00320019, "INR":0.0586469, "JPY":0.0985917, "USD":8.7125E-4, "EUR":8.11008E-4 }, "JOD":{ "XAF":1.0, "AUD":1.0, "KRW":1.0, "GBP":1.0, "AED":1.0, "INR":1.0, "JPY":1.0, "USD":1.0, "EUR":1.0 }, "GBP":{ "XAF":762.826, "AUD":1.0, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":1.2493, "EUR":1.16278 }, "AED":{ "XAF":166.236, "AUD":1.0, "KRW":312.482, "GBP":0.217921, "AED":1.0, "INR":18.3255, "JPY":30.8081, "USD":0.27225, "EUR":0.253425 }, "INR":{ "XAF":9.07101, "AUD":1.0, "KRW":17.0512, "JOD":1.0, "GBP":0.0118913, "AED":0.0545671, "JPY":1.68111, "USD":0.0148559, "EUR":0.0138287 }, "JPY":{ "XAF":5.39585, "AUD":1.0, "KRW":10.1428, "JOD":1.0, "GBP":0.0070735, "AED":0.032459, "INR":0.594846, "USD":0.00883695, "EUR":0.00822592 }, "USD":{ "XAF":610.601, "AUD":1.0, "KRW":1147.78, "JOD":1.0, "GBP":0.800446, "AED":3.6731, "INR":67.3135, "JPY":113.161, "EUR":0.930886 }, "EUR":{ "XAF":655.957, "AUD":1.0, "KRW":1233.03, "JOD":1.0, "GBP":0.860011, "AED":3.94594, "INR":72.3136, "JPY":121.567, "USD":1.07428 } }
Transaction Requests satisfy PSD2 requirements thus:
1) A transaction can be initiated by a third party application.
2) The customer is informed of the charge that will incurred.
3) The call supports delegated authentication (OAuth)
See this python code for a complete example of this flow.
There is further documentation here
Authentication is Mandatory
{
"id":"4050046c-63b3-4868-8a22-14b4181d33a6",
"type":"SANDBOX_TAN",
"from":{
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"
},
"details":{
},
"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],
"status":"COMPLETED",
"start_date":"2013-01-22T00:08:00Z",
"end_date":"2013-01-22T00:08:00Z",
"challenge":{
"id":"be1a183d-b301-4b83-b855-5eeffdd3526f",
"allowed_attempts":3,
"challenge_type":"SANDBOX_TAN"
},
"charge":{
"summary":"Good",
"value":{
"currency":"EUR",
"amount":"10"
}
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20001: User not logged in. Authentication is required!
- 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-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
- OBP-10001: Incorrect json format.
- 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-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because you don't have access to the owner view of the from account or you don't have access to canCreateAnyTransactionRequest.
- OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE
- OBP-10001: Incorrect json format.
- OBP-10002: Invalid Number. Could not convert value to a number.
- OBP-40008: Can't send a payment with a value of 0 or less.
- OBP-40003: Transaction Request Currency must be the same as From Account Currency.
- OBP-00003: Transaction Requests is disabled in this API instance.
- OBP-50000: Unknown Error.
Create Transaction Request (FREE_FORM).
Initiate a Payment via creating a Transaction Request.
In OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
Transaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response. This provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
In sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.
In sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
If a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
You can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
The following static FX rates are available in sandbox mode:
{ "XAF":{ "AUD":1.0, "KRW":1.87975, "JOD":1.0, "GBP":0.00131092, "AED":0.00601555, "INR":0.110241, "JPY":0.185328, "USD":0.00163773, "EUR":0.00152449 }, "AUD":{ "XAF":762.826, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":0.79, "EUR":0.67 }, "KRW":{ "XAF":0.531986, "AUD":1.0, "JOD":1.0, "GBP":6.97389E-4, "AED":0.00320019, "INR":0.0586469, "JPY":0.0985917, "USD":8.7125E-4, "EUR":8.11008E-4 }, "JOD":{ "XAF":1.0, "AUD":1.0, "KRW":1.0, "GBP":1.0, "AED":1.0, "INR":1.0, "JPY":1.0, "USD":1.0, "EUR":1.0 }, "GBP":{ "XAF":762.826, "AUD":1.0, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":1.2493, "EUR":1.16278 }, "AED":{ "XAF":166.236, "AUD":1.0, "KRW":312.482, "GBP":0.217921, "AED":1.0, "INR":18.3255, "JPY":30.8081, "USD":0.27225, "EUR":0.253425 }, "INR":{ "XAF":9.07101, "AUD":1.0, "KRW":17.0512, "JOD":1.0, "GBP":0.0118913, "AED":0.0545671, "JPY":1.68111, "USD":0.0148559, "EUR":0.0138287 }, "JPY":{ "XAF":5.39585, "AUD":1.0, "KRW":10.1428, "JOD":1.0, "GBP":0.0070735, "AED":0.032459, "INR":0.594846, "USD":0.00883695, "EUR":0.00822592 }, "USD":{ "XAF":610.601, "AUD":1.0, "KRW":1147.78, "JOD":1.0, "GBP":0.800446, "AED":3.6731, "INR":67.3135, "JPY":113.161, "EUR":0.930886 }, "EUR":{ "XAF":655.957, "AUD":1.0, "KRW":1233.03, "JOD":1.0, "GBP":0.860011, "AED":3.94594, "INR":72.3136, "JPY":121.567, "USD":1.07428 } }
Transaction Requests satisfy PSD2 requirements thus:
1) A transaction can be initiated by a third party application.
2) The customer is informed of the charge that will incurred.
3) The call supports delegated authentication (OAuth)
See this python code for a complete example of this flow.
There is further documentation here
Authentication is Mandatory
{
"id":"4050046c-63b3-4868-8a22-14b4181d33a6",
"type":"SANDBOX_TAN",
"from":{
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"
},
"details":{
},
"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],
"status":"COMPLETED",
"start_date":"2013-01-22T00:08:00Z",
"end_date":"2013-01-22T00:08:00Z",
"challenge":{
"id":"be1a183d-b301-4b83-b855-5eeffdd3526f",
"allowed_attempts":3,
"challenge_type":"SANDBOX_TAN"
},
"charge":{
"summary":"Good",
"value":{
"currency":"EUR",
"amount":"10"
}
}
}
-
CanCreateAnyTransactionRequest
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20001: User not logged in. Authentication is required!
- 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-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
- OBP-10001: Incorrect json format.
- 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-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because you don't have access to the owner view of the from account or you don't have access to canCreateAnyTransactionRequest.
- OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE
- OBP-10001: Incorrect json format.
- OBP-10002: Invalid Number. Could not convert value to a number.
- OBP-40008: Can't send a payment with a value of 0 or less.
- OBP-40003: Transaction Request Currency must be the same as From Account Currency.
- OBP-00003: Transaction Requests is disabled in this API instance.
- OBP-50000: Unknown Error.
Create Transaction Request (SANDBOX_TAN)
When using SANDBOX_TAN, the payee is set in the request body.
Money goes into the BANK_ID and ACCOUNT_ID specified in the request body.
Initiate a Payment via creating a Transaction Request.
In OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
Transaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response. This provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
In sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.
In sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
If a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
You can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
The following static FX rates are available in sandbox mode:
{ "XAF":{ "AUD":1.0, "KRW":1.87975, "JOD":1.0, "GBP":0.00131092, "AED":0.00601555, "INR":0.110241, "JPY":0.185328, "USD":0.00163773, "EUR":0.00152449 }, "AUD":{ "XAF":762.826, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":0.79, "EUR":0.67 }, "KRW":{ "XAF":0.531986, "AUD":1.0, "JOD":1.0, "GBP":6.97389E-4, "AED":0.00320019, "INR":0.0586469, "JPY":0.0985917, "USD":8.7125E-4, "EUR":8.11008E-4 }, "JOD":{ "XAF":1.0, "AUD":1.0, "KRW":1.0, "GBP":1.0, "AED":1.0, "INR":1.0, "JPY":1.0, "USD":1.0, "EUR":1.0 }, "GBP":{ "XAF":762.826, "AUD":1.0, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":1.2493, "EUR":1.16278 }, "AED":{ "XAF":166.236, "AUD":1.0, "KRW":312.482, "GBP":0.217921, "AED":1.0, "INR":18.3255, "JPY":30.8081, "USD":0.27225, "EUR":0.253425 }, "INR":{ "XAF":9.07101, "AUD":1.0, "KRW":17.0512, "JOD":1.0, "GBP":0.0118913, "AED":0.0545671, "JPY":1.68111, "USD":0.0148559, "EUR":0.0138287 }, "JPY":{ "XAF":5.39585, "AUD":1.0, "KRW":10.1428, "JOD":1.0, "GBP":0.0070735, "AED":0.032459, "INR":0.594846, "USD":0.00883695, "EUR":0.00822592 }, "USD":{ "XAF":610.601, "AUD":1.0, "KRW":1147.78, "JOD":1.0, "GBP":0.800446, "AED":3.6731, "INR":67.3135, "JPY":113.161, "EUR":0.930886 }, "EUR":{ "XAF":655.957, "AUD":1.0, "KRW":1233.03, "JOD":1.0, "GBP":0.860011, "AED":3.94594, "INR":72.3136, "JPY":121.567, "USD":1.07428 } }
Transaction Requests satisfy PSD2 requirements thus:
1) A transaction can be initiated by a third party application.
2) The customer is informed of the charge that will incurred.
3) The call supports delegated authentication (OAuth)
See this python code for a complete example of this flow.
There is further documentation here
Authentication is Mandatory
{
"id":"4050046c-63b3-4868-8a22-14b4181d33a6",
"type":"SANDBOX_TAN",
"from":{
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"
},
"details":{
},
"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],
"status":"COMPLETED",
"start_date":"2013-01-22T00:08:00Z",
"end_date":"2013-01-22T00:08:00Z",
"challenge":{
"id":"be1a183d-b301-4b83-b855-5eeffdd3526f",
"allowed_attempts":3,
"challenge_type":"SANDBOX_TAN"
},
"charge":{
"summary":"Good",
"value":{
"currency":"EUR",
"amount":"10"
}
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20001: User not logged in. Authentication is required!
- 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-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
- OBP-10001: Incorrect json format.
- 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-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because you don't have access to the owner view of the from account or you don't have access to canCreateAnyTransactionRequest.
- OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE
- OBP-10001: Incorrect json format.
- OBP-10002: Invalid Number. Could not convert value to a number.
- OBP-40008: Can't send a payment with a value of 0 or less.
- OBP-40003: Transaction Request Currency must be the same as From Account Currency.
- OBP-00003: Transaction Requests is disabled in this API instance.
- OBP-50000: Unknown Error.
Create Transaction Request (SEPA)
Special instructions for SEPA:
When using a SEPA Transaction Request, you specify the IBAN of a Counterparty in the body of the request. The routing details (IBAN) of the counterparty will be forwarded to the core banking system for the transfer.
Initiate a Payment via creating a Transaction Request.
In OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
Transaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response. This provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
In sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.
In sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
If a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
You can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
The following static FX rates are available in sandbox mode:
{ "XAF":{ "AUD":1.0, "KRW":1.87975, "JOD":1.0, "GBP":0.00131092, "AED":0.00601555, "INR":0.110241, "JPY":0.185328, "USD":0.00163773, "EUR":0.00152449 }, "AUD":{ "XAF":762.826, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":0.79, "EUR":0.67 }, "KRW":{ "XAF":0.531986, "AUD":1.0, "JOD":1.0, "GBP":6.97389E-4, "AED":0.00320019, "INR":0.0586469, "JPY":0.0985917, "USD":8.7125E-4, "EUR":8.11008E-4 }, "JOD":{ "XAF":1.0, "AUD":1.0, "KRW":1.0, "GBP":1.0, "AED":1.0, "INR":1.0, "JPY":1.0, "USD":1.0, "EUR":1.0 }, "GBP":{ "XAF":762.826, "AUD":1.0, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":1.2493, "EUR":1.16278 }, "AED":{ "XAF":166.236, "AUD":1.0, "KRW":312.482, "GBP":0.217921, "AED":1.0, "INR":18.3255, "JPY":30.8081, "USD":0.27225, "EUR":0.253425 }, "INR":{ "XAF":9.07101, "AUD":1.0, "KRW":17.0512, "JOD":1.0, "GBP":0.0118913, "AED":0.0545671, "JPY":1.68111, "USD":0.0148559, "EUR":0.0138287 }, "JPY":{ "XAF":5.39585, "AUD":1.0, "KRW":10.1428, "JOD":1.0, "GBP":0.0070735, "AED":0.032459, "INR":0.594846, "USD":0.00883695, "EUR":0.00822592 }, "USD":{ "XAF":610.601, "AUD":1.0, "KRW":1147.78, "JOD":1.0, "GBP":0.800446, "AED":3.6731, "INR":67.3135, "JPY":113.161, "EUR":0.930886 }, "EUR":{ "XAF":655.957, "AUD":1.0, "KRW":1233.03, "JOD":1.0, "GBP":0.860011, "AED":3.94594, "INR":72.3136, "JPY":121.567, "USD":1.07428 } }
Transaction Requests satisfy PSD2 requirements thus:
1) A transaction can be initiated by a third party application.
2) The customer is informed of the charge that will incurred.
3) The call supports delegated authentication (OAuth)
See this python code for a complete example of this flow.
There is further documentation here
Authentication is Mandatory
{
"id":"4050046c-63b3-4868-8a22-14b4181d33a6",
"type":"SANDBOX_TAN",
"from":{
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"
},
"details":{
},
"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],
"status":"COMPLETED",
"start_date":"2013-01-22T00:08:00Z",
"end_date":"2013-01-22T00:08:00Z",
"challenge":{
"id":"be1a183d-b301-4b83-b855-5eeffdd3526f",
"allowed_attempts":3,
"challenge_type":"SANDBOX_TAN"
},
"charge":{
"summary":"Good",
"value":{
"currency":"EUR",
"amount":"10"
}
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20001: User not logged in. Authentication is required!
- 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-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
- OBP-10001: Incorrect json format.
- 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-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because you don't have access to the owner view of the from account or you don't have access to canCreateAnyTransactionRequest.
- OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE
- OBP-10001: Incorrect json format.
- OBP-10002: Invalid Number. Could not convert value to a number.
- OBP-40008: Can't send a payment with a value of 0 or less.
- OBP-40003: Transaction Request Currency must be the same as From Account Currency.
- OBP-00003: Transaction Requests is disabled in this API instance.
- OBP-50000: Unknown Error.
Get Transaction Request Types for Account
Returns the Transation Request Types that the account specified by ACCOUNT_ID and view specified by VIEW_ID has access to.
These are the ways this API Server can create a Transaction via a Transaction Request (as opposed to Transaction Types which include external types too e.g. for Transactions created by core banking etc.)
A Transaction Request Type internally determines:
- the required Transaction Request 'body' i.e. fields that define the 'what' and 'to' of a Transaction Request,
- the type of security challenge that may be be raised before the Transaction Request proceeds, and
- the threshold of that challenge.
For instance in a 'SANDBOX_TAN' Transaction Request, for amounts over 1000 currency units, the user must supply a positive integer to complete the Transaction Request and create a Transaction.
This approach aims to provide only one endpoint for initiating transactions, and one that handles challenges, whilst still allowing flexibility with the payload and internal logic.
This endpoint works with firehose
{
"transaction_request_types":[{
"value":"10",
"charge":{
"summary":"Good",
"value":{
"currency":"EUR",
"amount":"10"
}
}
}]
}
- OBP-20001: User not logged in. Authentication is required!
- 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.
- Please specify a valid value for CURRENCY of your Bank Account.
- Current user does not have access to the view
- account not found at bank
- user does not have access to owner view
- Sorry, Transaction Requests are not enabled in this API instance.
- OBP-50000: Unknown Error.
Get Transaction Requests.
Returns transaction requests for account specified by ACCOUNT_ID at bank specified by BANK_ID.
The VIEW_ID specified must be 'owner' and the user must have access to this view.
Version 2.0.0 now returns charge information.
Transaction Requests serve to initiate transactions that may or may not proceed. They contain information including:
- Transaction Request Id
- Type
- Status (INITIATED, COMPLETED)
- Challenge (in order to confirm the request)
- From Bank / Account
- Details including Currency, Value, Description and other initiation information specific to each type. (Could potentialy include a list of future transactions.)
- Related Transactions
PSD2 Context: PSD2 requires transparency of charges to the customer. This endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after. The customer can proceed with the Transaction by answering the security challenge.
This endpoint works with firehose.
{
"transaction_requests_with_charges":[{
"id":"4050046c-63b3-4868-8a22-14b4181d33a6",
"type":"SANDBOX_TAN",
"from":{
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"
},
"details":{
},
"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],
"status":"COMPLETED",
"start_date":"2013-01-22T00:08:00Z",
"end_date":"2013-01-22T00:08:00Z",
"challenge":{
"id":"be1a183d-b301-4b83-b855-5eeffdd3526f",
"allowed_attempts":3,
"challenge_type":"SANDBOX_TAN"
},
"charge":{
"summary":"Good",
"value":{
"currency":"EUR",
"amount":"10"
}
}
}]
}
- OBP-20001: User not logged in. Authentication is required!
- 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-20006: User is missing one or more roles:
- OBP-20019: User does not have access to owner view.
- OBP-50000: Unknown Error.
Get supported Transaction Request Types
Get the list of the Transaction Request Types supported by the bank.
Authentication is Optional
{
"transaction_request_types":[{
"transaction_request_type":"SandboxTan"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Create User.
Creates OBP user. No authorisation (currently) required.
Mimics current webform to Register.
Requires username(email) and password.
Returns 409 error if username not unique.
May require validation of email address.
{
"user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"email":"robert.x.0.gh@example.com",
"provider_id":"OBP",
"provider":"OBP",
"username":"robert.x.0.gh",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-30207: Invalid Password Format. Your password should EITHER be at least 10 characters long and contain mixed numbers and both upper and lower case letters and at least one special character, OR be longer than 16 characters.
- Error occurred during user creation.
- User with the same username already exists.
- OBP-50000: Unknown Error.
Get User (Current)
Get the logged in user
Authentication is Mandatory
{
"user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"email":"robert.x.0.gh@example.com",
"provider_id":"OBP",
"provider":"OBP",
"username":"robert.x.0.gh",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get User by USERNAME
Get user by USERNAME
Authentication is Mandatory
CanGetAnyUser entitlement is required,
{
"users":[{
"user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"email":"robert.x.0.gh@example.com",
"provider_id":"OBP",
"provider":"OBP",
"username":"robert.x.0.gh",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
}]
}
-
CanGetAnyUser
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-20027: User not found by username.
- OBP-50000: Unknown Error.
Get User by USER_ID
Get user by USER_ID
Authentication is Mandatory CanGetAnyUser entitlement is required,
{
"users":[{
"user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"email":"robert.x.0.gh@example.com",
"provider_id":"OBP",
"provider":"OBP",
"username":"robert.x.0.gh",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
}]
}
-
CanGetAnyUser
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-20005: User not found. Please specify a valid value for USER_ID.
- OBP-50000: Unknown Error.
Get Users by Email Address
Get users by email address
Authentication is Mandatory CanGetAnyUser entitlement is required,
{
"users":[{
"user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"email":"robert.x.0.gh@example.com",
"provider_id":"OBP",
"provider":"OBP",
"username":"robert.x.0.gh",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
}]
}
-
CanGetAnyUser
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-20007: User not found by email.
- OBP-50000: Unknown Error.
Get all Users
Get all users
Authentication is Mandatory
CanGetAnyUser entitlement is required,
{
"users":[{
"user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"email":"robert.x.0.gh@example.com",
"provider_id":"OBP",
"provider":"OBP",
"username":"robert.x.0.gh",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
}]
}
-
CanGetAnyUser
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.