-
API
-
The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeablyMore...
- Get API Info (root)
-
-
Account
-
The thing that tokens of value (money) come in and out of. An account has one or more `owners` whichMore...
- Create View
- Get access for specific user
- Get account by id
- Get accounts at all banks (Private, inc views)
- Get accounts at bank (Private)
- Get private accounts at all banks (Authenticated access)
- Get private accounts at one bank
- Get public accounts at all banks (Anonymous access)
- Update Account Label
- Update View
-
-
Bank
-
A Bank (aka Space) represents a financial institution, brand or organizational unit under which resMore...
- Get Bank
- Get Bank ATMS
- Get Bank Products
- Get Banks
-
-
Counterparty Metadata
- 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
-
The legal entity that has the relationship to the bank. Customers are linked to Users via `User CusMore...
- Add a customer
- Get CRM Events
- Get customer for logged in user
-
-
Transaction
-
Transactions are records of successful movements of value into or out of an `Account`. OBP TransacMore...
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Full)
-
-
Transaction Metadata
- Add a Transaction Comment
- Add a Transaction Image
- Add a Transaction Narrative
- Add a Transaction Tag
- Add a Transaction where Tag
- Delete a Transaction Comment
- Delete a Transaction Image
- Delete a Transaction Narrative
- Delete a Transaction Tag
- Delete a Transaction Tag
- Get Transaction Comments
- Get Transaction Images
- Get Transaction Tags
- Get a Transaction Narrative
- Get a Transaction where Tag
- Update a Transaction Narrative
- Update a Transaction where Tag
-
API
-
Account
- Create View
- Get access for specific user
- Get account by id
- Get accounts at all banks (Private, inc views)
- Get accounts at bank (Private)
- Get private accounts at all banks (Authenticated access)
- Get private accounts at one bank
- Get public accounts at all banks (Anonymous access)
- Update Account Label
- Update View
-
Account Public
-
Bank
-
Branch
-
Card
-
Counterparty
-
Counterparty Metadata
- 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
-
Customer Message
-
Documentation
-
Dynamic Resource Doc
-
Transaction
-
Transaction Metadata
- Add a Transaction Comment
- Add a Transaction Image
- Add a Transaction Narrative
- Add a Transaction Tag
- Add a Transaction where Tag
- Delete a Transaction Comment
- Delete a Transaction Image
- Delete a Transaction Narrative
- Delete a Transaction Tag
- Delete a Transaction Tag
- Get Transaction Comments
- Get Transaction Images
- Get Transaction Tags
- Get a Transaction Narrative
- Get a Transaction where Tag
- Update a Transaction Narrative
- Update a Transaction where Tag
-
Transaction Request
- Answer Transaction Request Challenge
- Create Transaction Request
- Get Transaction Request Types for Account
- Get all Transaction Requests
-
View Custom
- Delete Custom View
- Get Views for Account
- Get access
- 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
-
_Authority Data Request
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(000202)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(ADOPEM)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(APAP)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(BANRESERVAS)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(BHD LEON)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(CONFISA)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(POPULAR)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(SCOTIABANK)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(brrd 01)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Foo Bar
-
_Obp Activity(trn.34.my.strings)
- Create new Obp Activity
- Delete Obp Activity by id
- Get Obp Activity List
- Get Obp Activity by id
- Update Obp Activity
v1.4.0 (149 APIs)
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
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
full_name: full name string
id: d8839721-ad8f-45dd-9f78-2080414b93f9
logo: logo url
scheme: scheme value
{
"id":"gh.29.uk",
"short_name":"short_name ",
"full_name":"full_name",
"logo":"logo",
"website":"www.openbankproject.com",
"bank_routing":{
"scheme":"scheme value",
"address":""
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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 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
Possible custom url parameters for pagination:
- limit=NUMBER ==> default value: 500
- offset=NUMBER ==> default value: 0
eg1:?limit=100&offset=0
- sort_direction=ASC/DESC ==> default value: DESC.
eg2:?limit=100&offset=0&sort_direction=ASC
Authentication is Optional
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
atms:
city:
country: Germany
id: d8839721-ad8f-45dd-9f78-2080414b93f9
latitude: 38.8951
longitude: -77.0364
meta:
name: ACCOUNT_MANAGEMENT_FEE
{
"atms":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"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
},
"meta":{
"license":{
"id":"ODbL-1.0",
"name":"Open Database License"
}
}
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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.
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
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
code: 125
id: d8839721-ad8f-45dd-9f78-2080414b93f9
meta:
more_info_url: www.example.com/abc
name: ACCOUNT_MANAGEMENT_FEE
{
"products":[{
"code":"String",
"name":"String",
"category":"String",
"family":"String",
"super_family":"String",
"more_info_url":"String",
"meta":{
"license":{
"id":"ODbL-1.0",
"name":"Open Database License"
}
}
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- No products available.
- License may not be set.
- OBP-50000: Unknown Error.
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
Authentication is Optional
JSON response body fields:
full_name: full name string
id: d8839721-ad8f-45dd-9f78-2080414b93f9
logo: logo url
scheme: scheme value
{
"banks":[{
"id":"gh.29.uk",
"short_name":"short_name ",
"full_name":"full_name",
"logo":"logo",
"website":"www.openbankproject.com",
"bank_routing":{
"scheme":"scheme value",
"address":""
}
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.