-
API
-
The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeablyMore...
- Get API Configuration
- Get API Info (root)
- Get Adapter Info
- Get Adapter Info for a bank
- Get Connector Status (Loopback)
- Get JSON Web Key (JWK)
- Get JSON Web Key (JWK) URIs
- Get Rate Limiting Info
-
-
Account
-
The thing that tokens of value (money) come in and out of. An account has one or more `owners` whichMore...
- Check Available Funds
- Create Account
- Create Account Attribute
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts Balances
- Get Accounts Held
- Get Accounts at Bank
- Get Accounts at Bank (IDs only)
- Get Accounts at Bank (Minimal)
- Get Accounts at all Banks (private)
- Get Checkbook orders
- Get Firehose Accounts at Bank
- Update Account
- Update Account Attribute
- Update Account Label
-
-
Bank
-
A Bank (aka Space) represents a financial institution, brand or organizational unit under which resMore...
- Create Bank
- Create Transaction Type at bank
- Get Bank
- Get Banks
- Get Transaction Types at Bank
-
-
Consent
-
Consents provide a mechanism by which a third party App or User can access resources on behalf of aMore...
- Answer Consent Challenge
- Create Consent (EMAIL)
- Create Consent (IMPLICIT)
- Create Consent (SMS)
- Get Consents
- Revoke Consent
-
-
Consumer
-
The "consumer" of the API, i.e. the web, mobile or serverside "App" that calls on the OBP API on beMore...
- Enable or Disable Consumers
- Get Call Limits for a Consumer
- Get Consumer
- Get Consumers
- Get Consumers (logged in User)
- Set Rate Limiting (call limits) per Consumer
- Update Consumer RedirectUrl
-
-
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...
- Create Address
- Create Customer
- Create Customer Social Media Handle
- Create Tax Residence
- Create User Customer Link
- Delete Customer Address
- Delete Tax Residence
- Get CRM Events
- Get Customer Addresses
- Get Customer Social Media Handles
- Get Customer by CUSTOMER_ID
- Get Customer by CUSTOMER_NUMBER
- Get Customers for Current User
- Get Customers for current User at Bank
- Get Firehose Customers
- Get Tax Residences of Customer
- Update the Address of a Customer
- Update the Branch of a Customer
- Update the credit limit of a Customer
- Update the credit rating and source of a Customer
- Update the email of a Customer
- Update the identity data of a Customer
- Update the mobile number of a Customer
- Update the number of a Customer
- Update the other data of a Customer
-
-
Method Routing
-
Open Bank Project can have different connectors, to connect difference data sources. We supportMore...
- Create MethodRouting
- Delete MethodRouting
- Get MethodRoutings
- Update MethodRouting
-
-
Role
- Add Entitlement for a User
- Create Entitlement Request for current 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
-
Transactions are records of successful movements of value into or out of an `Account`. OBP TransacMore...
- Get Firehose Transactions for Account
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Core)
- 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
-
Transaction Request
- 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 at Bank
- Get Transaction Request Types for Account
- Get Transaction Requests
- Save Historical Transactions
-
User
-
The entity that accesses the API with a login / authorisation token and has access to zero or moreMore...
- Answer Auth Context Update Challenge
- Create User
- Create User Auth Context
- Create User Auth Context Update Request
- Delete User Auth Context
- Delete User's Auth Contexts
- Get User (Current)
- Get User Auth Contexts
- Get User Lock Status
- Get User by USERNAME
- Get User by USER_ID
- Get Users by Email Address
- Get all Users
- Refresh User
- Unlock the user
-
-
API
- Get API Configuration
- Get API Info (root)
- Get Adapter Info
- Get Adapter Info for a bank
- Get Connector Status (Loopback)
- Get JSON Web Key (JWK)
- Get JSON Web Key (JWK) URIs
- Get Rate Limiting Info
-
ATM
-
Account
- Check Available Funds
- Create Account
- Create Account Attribute
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts Balances
- Get Accounts Held
- Get Accounts at Bank
- Get Accounts at Bank (IDs only)
- Get Accounts at Bank (Minimal)
- Get Accounts at all Banks (private)
- Get Checkbook orders
- Get Firehose Accounts at Bank
- Update Account
- Update Account Attribute
- Update Account Label
-
Account Application
- Create Account Application
- Get Account Application by Id
- Get Account Applications
- Update Account Application Status
-
Account Public
-
Bank
-
Bank Accounts (Dynamic Endpoint)
-
Branch
-
Card
- Create Card
- Create Card Attribute
- Delete Card
- Get Card By Id
- Get Cards for the specified bank
- Get cards for the current user
- Get status of Credit Card order
- Update Card
- Update Card Attribute
-
Consent
- Answer Consent Challenge
- Create Consent (EMAIL)
- Create Consent (IMPLICIT)
- Create Consent (SMS)
- Get Consents
- Revoke Consent
-
Consumer
- Enable or Disable Consumers
- Get Call Limits for a Consumer
- Get Consumer
- Get Consumers
- Get Consumers (logged in User)
- Set Rate Limiting (call limits) per Consumer
- Update Consumer RedirectUrl
-
Counterparty
- Create Counterparty (Explicit)
- Get Counterparties (Explicit)
- Get Counterparty by Counterparty Id (Explicit)
- Get Other Account by Id
- Get Other Accounts of one Account
-
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
- Create Address
- Create Customer
- Create Customer Social Media Handle
- Create Tax Residence
- Create User Customer Link
- Delete Customer Address
- Delete Tax Residence
- Get CRM Events
- Get Customer Addresses
- Get Customer Social Media Handles
- Get Customer by CUSTOMER_ID
- Get Customer by CUSTOMER_NUMBER
- Get Customers for Current User
- Get Customers for current User at Bank
- Get Firehose Customers
- Get Tax Residences of Customer
- Update the Address of a Customer
- Update the Branch of a Customer
- Update the credit limit of a Customer
- Update the credit rating and source of a Customer
- Update the email of a Customer
- Update the identity data of a Customer
- Update the mobile number of a Customer
- Update the number of a Customer
- Update the other data of a Customer
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
Documentation
- Get Bank Level Dynamic Resource Docs
- Get Glossary of the API
- Get Message Docs
- Get Message Docs Swagger
- Get Resource Docs
- Get Resource Docs
- Get Swagger documentation
-
Dynamic Resource Doc
-
FX
-
KYC
- Add KYC Check
- Add KYC Document
- Add KYC Media
- Add KYC Status
- Get Customer KYC Checks
- Get Customer KYC Documents
- Get Customer KYC statuses
- Get KYC Media for a customer
-
Method Routing
-
Metric
- Get Aggregate Metrics
- Get Connector Metrics
- Get Metrics
- Get Top APIs
- Get Top Consumers
- Search API Metrics via Elasticsearch
-
Product
- Create Product
- Create Product Attribute
- Delete Product Attribute
- Get Bank Product
- Get Product Attribute
- Get Product Tree
- Get Products
- Update Product Attribute
-
Product Collection
-
Role
- Add Entitlement for a User
- Create Entitlement Request for current 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
-
Sandbox
-
Scope
-
Transaction
- Get Firehose Transactions for Account
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Core)
- 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
-
Transaction Request
- 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 at Bank
- Get Transaction Request Types for Account
- Get Transaction Requests
- Save Historical Transactions
-
User
- Answer Auth Context Update Challenge
- Create User
- Create User Auth Context
- Create User Auth Context Update Request
- Delete User Auth Context
- Delete User's Auth Contexts
- Get User (Current)
- Get User Auth Contexts
- Get User Lock Status
- Get User by USERNAME
- Get User by USER_ID
- Get Users by Email Address
- Get all Users
- Refresh User
- Unlock the user
-
View Custom
- Create Custom View
- Delete Custom View
- Get Account access for User
- 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
- Update Custom View
-
View System
-
WebUi Props
-
Webhook
-
_Covid APIDays
- Create new Covid APIDays
- Delete Covid APIDays by id
- Get Covid APIDays List
- Get Covid APIDays by id
- Update Covid APIDays
-
_Customer Cars
- Create new Customer Cars
- Delete Customer Cars by id
- Get Customer Cars List
- Get Customer Cars by id
- Update Customer Cars
-
_D Entity1(gh.29.uk)
-
_Fish Port
-
_Foo Bar
-
_Insurance Policy(gh.29.uk)
- Create new Insurance Policy
- Delete Insurance Policy by id
- Get Insurance Policy List
- Get Insurance Policy by id
- Update Insurance Policy
-
_Insurance Premium(gh.29.uk)
- Create new Insurance Premium
- Delete Insurance Premium by id
- Get Insurance Premium List
- Get Insurance Premium by id
- Update Insurance Premium
-
_March Hare(gh.29.uk)
- Create new March Hare
- Delete March Hare by id
- Get March Hare List
- Get March Hare by id
- Update March Hare
-
_Obp Activity(obp.testing.01)
- Create new Obp Activity
- Delete Obp Activity by id
- Get Obp Activity List
- Get Obp Activity by id
- Update Obp Activity
-
_Odometer(gh.29.uk)
-
_Simon Covid
- Create new Simon Covid
- Delete Simon Covid by id
- Get Simon Covid List
- Get Simon Covid by id
- Update Simon Covid
-
_Sustrans
-
_Test Daniel707
- Create new My Test Daniel707
- Create new Test Daniel707
- Delete My Test Daniel707 by id
- Delete Test Daniel707 by id
- Get My Test Daniel707 List
- Get My Test Daniel707 by id
- Get Test Daniel707 List
- Get Test Daniel707 by id
- Update My Test Daniel707
- Update Test Daniel707
-
_Test1
v3.1.0 (327 APIs)
Check Available Funds
Check Available Funds
Mandatory URL parameters:
- amount=NUMBER
- currency=STRING
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON response body fields:
date: 2020-01-27
{
"answer":"yes",
"date":"2024-09-12T13:08:21Z",
"available_funds_request_id":"c4ykz59svsr9b7fmdxk8ezs7"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-20054: Invalid amount. Please specify a valid value for amount.
- OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
- OBP-50000: Unknown Error.
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 - the User that has the USER_ID specified in the POST body.
If the PUT body USER_ID is specified, the logged in user must have the Role canCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.
If the PUT body USER_ID is not specified, the account will be owned by the logged in User.
The 'product_code' field SHOULD be a product_code from Product.
If the 'product_code' matches a product_code from Product, account attributes will be created that match the Product Attributes.
Note: The Amount MUST be zero.
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
amount: 10.12
balance: 10
branch_id: DERBY6
currency: EUR
label: My Account
name: ACCOUNT_MANAGEMENT_FEE
product_code: 1234BW
scheme: scheme value
type:
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
value: 5987953
product_instance_code: product_instance_code
{
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"label":"My Account",
"product_code":"1234BW",
"balance":{
"currency":"EUR",
"amount":"0"
},
"branch_id":"DERBY6",
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"account_attributes":[{
"product_code":"1234BW",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23",
"product_instance_code":"LKJL98769F"
}]
}
-
CanCreateAccount
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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 Account Attribute
Create Account Attribute
Account Attributes are used to describe a financial Product with a list of typed key value pairs.
Each Account Attribute is linked to its Account by ACCOUNT_ID
Typical account attributes might be:
ISIN (for International bonds)
VKN (for German bonds)
REDCODE (markit short code for credit derivative)
LOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
MATURITY_DATE (End of life time of a product)
TRADABLE
See FPML for more examples.
The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
PRODUCT_CODE: 1234BW
JSON request body fields:
name: ACCOUNT_MANAGEMENT_FEE
type:
value: 5987953
product_instance_code: product_instance_code
JSON response body fields:
name: ACCOUNT_MANAGEMENT_FEE
product_code: 1234BW
type:
value: 5987953
product_instance_code: product_instance_code
{
"product_code":"1234BW",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23",
"product_instance_code":"LKJL98769F"
}
-
CanCreateAccountAttributeAtOneBank
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
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.
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
JSON response body fields:
amount: 10.12
balance: 10
bank_id: gh.29.uk
currency: EUR
description: This an optional field. Maximum length is 2000. It can be any characters here.
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_public: false
label: My Account
provider: ETHEREUM
scheme: scheme value
type:
{
"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"bank_id":"gh.29.uk",
"label":"My Account",
"number":"546387432",
"owners":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}],
"type":"AC",
"balance":{
"currency":"EUR",
"amount":"0"
},
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"views_basic":[{
"id":"owner",
"short_name":"owner",
"description":"This view is for the owner for the account.",
"is_public":false
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
Get Account by Id (Full)
Information returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):
- Number
- Owners
- Type
- Balance
- IBAN
- Available views (sorted by short_name)
More details about the data moderation by the view here.
PSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
This call provides balance and other account information via delegated authentication using OAuth.
Authentication is required if the 'is_public' field in view (VIEW_ID) is not set to true
.
Authentication is Optional
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON response body fields:
amount: 10.12
balance: 10
bank_id: gh.29.uk
can_add_image_url: false
can_add_more_info: false
can_add_tag: false
can_delete_corporate_location: false
can_delete_image: false
can_delete_where_tag: false
can_edit_owner_comment: false
can_see_bank_account_bank_name: false
can_see_bank_account_currency:
can_see_bank_account_label: false
can_see_bank_account_national_identifier:
can_see_bank_account_number: false
can_see_bank_account_owners: false
can_see_bank_account_swift_bic:
can_see_corporate_location: false
can_see_image_url: false
can_see_images: false
can_see_other_account_bank_name:
can_see_other_account_metadata:
can_see_other_account_national_identifier: false
can_see_other_account_number: false
can_see_other_account_swift_bic: false
can_see_transaction_amount: false
can_see_transaction_description: false
can_see_transaction_finish_date:
can_see_transaction_other_bank_account:
can_see_transaction_start_date:
can_see_transaction_this_bank_account:
can_see_url: false
can_see_where_tag: false
currency: EUR
description: This an optional field. Maximum length is 2000. It can be any characters here.
hide_metadata_if_alias_used: false
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_public: false
label: My Account
name: ACCOUNT_MANAGEMENT_FEE
product_code: 1234BW
provider: ETHEREUM
scheme: scheme value
type:
value: 5987953
product_instance_code: product_instance_code
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"NoneLabel",
"number":"123",
"owners":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}],
"type":"OBP",
"balance":{
"currency":"EUR",
"amount":"0"
},
"views_available":[{
"id":"123",
"short_name":"short_name",
"description":"description",
"is_public":true,
"alias":"None",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_see_bank_account_bank_name":true,
"can_see_bank_account_currency":true,
"can_see_bank_account_iban":true,
"can_see_bank_account_label":true,
"can_see_bank_account_national_identifier":true,
"can_see_bank_account_number":true,
"can_see_bank_account_owners":true,
"can_see_bank_account_swift_bic":true,
"can_see_bank_account_type":true,
"can_see_comments":true,
"can_see_corporate_location":true,
"can_see_image_url":true,
"can_see_images":true,
"can_see_more_info":true,
"can_see_open_corporates_url":true,
"can_see_other_account_bank_name":true,
"can_see_other_account_iban":true,
"can_see_other_account_kind":true,
"can_see_other_account_metadata":true,
"can_see_other_account_national_identifier":true,
"can_see_other_account_number":true,
"can_see_other_account_swift_bic":true,
"can_see_owner_comment":true,
"can_see_physical_location":true,
"can_see_private_alias":true,
"can_see_public_alias":true,
"can_see_tags":true,
"can_see_transaction_amount":true,
"can_see_transaction_balance":true,
"can_see_transaction_currency":true,
"can_see_transaction_description":true,
"can_see_transaction_finish_date":true,
"can_see_transaction_metadata":true,
"can_see_transaction_other_bank_account":true,
"can_see_transaction_start_date":true,
"can_see_transaction_this_bank_account":true,
"can_see_transaction_type":true,
"can_see_url":true,
"can_see_where_tag":true
}],
"bank_id":"gh.29.uk",
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"account_attributes":[{
"product_code":"1234BW",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23",
"product_instance_code":"LKJL98769F"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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 Balances
Get the Balances for the Accounts of the current User at one bank.
Authentication is Optional
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
amount: 10.12
balance: 10
bank_id: gh.29.uk
currency: EUR
id: d8839721-ad8f-45dd-9f78-2080414b93f9
label: My Account
overall_balance: 10
overall_balance_date: 2020-01-27
scheme: scheme value
{
"accounts":[{
"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"label":"My Account",
"bank_id":"gh.29.uk",
"account_routings":[{
"scheme":"accountNumber",
"address":"123456"
}],
"balance":{
"currency":"EUR",
"amount":"100"
}
}],
"overall_balance":{
"currency":"EUR",
"amount":"100"
},
"overall_balance_date":"1100-01-01T01:01:01Z"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
Get Accounts Held
Get Accounts held by the current User if even the User has not been assigned the owner View yet.
Can be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.
optional request parameters:
- account_type_filter: one or many accountType value, split by comma
- account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE
whole url example:
/banks/BANK_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
bank_id: gh.29.uk
id: d8839721-ad8f-45dd-9f78-2080414b93f9
label: My Account
scheme: scheme value
{
"accounts":[{
"id":"12314",
"label":"My Account",
"bank_id":"123",
"number":"123",
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}]
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Accounts at Bank
Returns the list of accounts at BANK_ID that the user has access to.
For each account the API returns the account ID and the views available to the user..
Each account must have at least one private View.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
bank_id: gh.29.uk
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_public: false
label: My Account
{
"accounts":[{
"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"label":"NoneLabel",
"bank_id":"gh.29.uk",
"views_available":[{
"id":"1",
"short_name":"HHH",
"is_public":true
}]
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
Get Accounts at Bank (IDs only)
Returns only the list of accounts ids at BANK_ID that the user has access to.
Each account must have at least one private View.
For each account the API returns its account ID.
If you want to see more information on the Views, use the Account Detail call.
optional request parameters:
- account_type_filter: one or many accountType value, split by comma
- account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE
whole url example:
/banks/BANK_ID/accounts/account_ids/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
id: d8839721-ad8f-45dd-9f78-2080414b93f9
{
"accounts":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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 Accounts at Bank (Minimal)
Returns the minimal list of private accounts at BANK_ID that the user has access to.
For each account, the API returns the ID, routing addresses and the views available to the current user.
If you want to see more information on the Views, use the Account Detail call.
optional request parameters:
- account_type_filter: one or many accountType value, split by comma
- account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE
whole url example:
/banks/BANK_ID/accounts/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
account_type: AC
bank_id: gh.29.uk
description: This an optional field. Maximum length is 2000. It can be any characters here.
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_public: false
label: My Account
scheme: scheme value
{
"accounts":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"String",
"bank_id":"gh.29.uk",
"account_type":"330",
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"views":[{
"id":"owner",
"short_name":"owner",
"description":"This view is for the owner for the account.",
"is_public":false
}]
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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 Accounts at all Banks (private)
Returns the list of accounts containing private views for the user.
Each account lists the views available to the user.
optional request parameters:
- account_type_filter: one or many accountType value, split by comma
- account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE
whole url example:
/my/accounts?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
JSON response body fields:
account_type: AC
bank_id: gh.29.uk
description: This an optional field. Maximum length is 2000. It can be any characters here.
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_public: false
label: My Account
scheme: scheme value
{
"accounts":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"String",
"bank_id":"gh.29.uk",
"account_type":"330",
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"views":[{
"id":"owner",
"short_name":"owner",
"description":"This view is for the owner for the account.",
"is_public":false
}]
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Checkbook orders
Get all checkbook orders
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
account_type: AC
bank_id: gh.29.uk
order_date: 2020-01-27
scheme: scheme value
{
"account":{
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"account_type":"330",
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"branch_routings":[{
"scheme":"BranchNumber",
"address":"678"
}]
},
"orders":[{
"order":{
"order_id":"xjksajfkj",
"order_date":"07082013",
"number_of_checkbooks":"4",
"distribution_channel":"1201",
"status":"2",
"first_check_number":"5165276",
"shipping_code":"1"
}
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50211: Connector did not return the set of check book.
- OBP-50000: Unknown Error.
Get Firehose Accounts at Bank
Get Accounts which have a firehose view assigned to them.
This endpoint allows bulk access to accounts.
Requires the CanUseFirehoseAtAnyBank Role
To be shown on the list, each Account must have a firehose View linked to it.
A firehose view has is_firehose = true
For VIEW_ID try 'owner'
optional request parameters for filter with attributes
URL params example:
/banks/some-bank-id/firehose/accounts/views/owner?manager=John&count=8
to invalid Browser cache, add timestamp query parameter as follow, the parameter name must be _timestamp_
URL params example:
/banks/some-bank-id/firehose/accounts/views/owner?manager=John&count=8&_timestamp_=1596762180358
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON response body fields:
amount: 10.12
balance: 10
bank_id: gh.29.uk
currency: EUR
id: d8839721-ad8f-45dd-9f78-2080414b93f9
label: My Account
provider: ETHEREUM
scheme: scheme value
type:
value: 5987953
{
"accounts":[{
"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"bank_id":"gh.29.uk",
"label":"My Account",
"number":"",
"owners":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}],
"type":"",
"balance":{
"currency":"EUR",
"amount":"0"
},
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"account_rules":[{
"scheme":"OVERDRAFT",
"value":"10"
}]
}]
}
-
CanUseAccountFirehoseAtAnyBank
- Please login to request this Role
-
CanUseAccountFirehose
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-00009: Account firehose is not allowed on this instance. Please set allow_account_firehose = true in props files.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Update Account
Update the account.
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
bank_id: gh.29.uk
branch_id: DERBY6
label: My Account
scheme: scheme value
type:
{
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"label":"Label",
"type":"CURRENT",
"branch_id":"1234",
"account_routings":[{
"scheme":"IBAN",
"address":"DE91 1000 0000 0123 4567 89"
}]
}
-
CanUpdateAccount
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-10001: Incorrect json format.
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-20006: User is missing one or more roles:
Update Account Attribute
Update Account Attribute
Account Attributes are used to describe a financial Product with a list of typed key value pairs.
Each Account Attribute is linked to its Account by ACCOUNT_ID
Typical account attributes might be:
ISIN (for International bonds)
VKN (for German bonds)
REDCODE (markit short code for credit derivative)
LOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
MATURITY_DATE (End of life time of a product)
TRADABLE
See FPML for more examples.
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
PRODUCT_CODE: 1234BW
JSON response body fields:
name: ACCOUNT_MANAGEMENT_FEE
product_code: 1234BW
type:
value: 5987953
product_instance_code: product_instance_code
{
"product_code":"1234BW",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23",
"product_instance_code":"LKJL98769F"
}
-
CanUpdateAccountAttribute
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
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'
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
JSON request body fields:
bank_id: gh.29.uk
id: d8839721-ad8f-45dd-9f78-2080414b93f9
label: My Account
JSON response body fields:
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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