-
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
-
-
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
-
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
-
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
-
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
-
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.2.1 (135 APIs)
API Host: https://ifcsandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions
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
Typical Successful Response:
{
"id":"gh.29.uk",
"short_name":"short_name ",
"full_name":"full_name",
"logo":"logo",
"website":"www.openbankproject.com",
"bank_routing":{
"scheme":"scheme value",
"address":""
}
}
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
Connector Methods:
Version: OBPv1.2.1,
function_name: by bankById, operation_id: OBPv1.2.1-bankById
Tags: Bank, PSD2, Old-Style,
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
Typical Successful Response:
{
"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":""
}
}]
}
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1,
function_name: by getBanks, operation_id: OBPv1.2.1-getBanks
Tags: Bank, PSD2, Old-Style,