-
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 (POST)
- Create Account (PUT)
- Create Account Attribute
- Create or Update Account Attribute Definition
- Delete Account Attribute Definition
- Delete Account Cascade
- Get Account Access by USER_ID
- Get Account Attribute Definition
- Get Account Balances
- Get Account Balances by BANK_ID
- Get Account Balances by BANK_ID
- Get Account Balances by BANK_ID and ACCOUNT_ID through the VIEW_ID
- Get Account by Account Routing
- Get Account by Id (Core)
- Get Account by Id (Core) through the VIEW_ID
- Get Account by Id (Full)
- Get Accounts Held
- Get Accounts Minimal for a Customer
- Get Accounts at Bank
- Get Accounts at Bank (IDs only)
- Get Accounts at Bank (Minimal)
- Get Accounts at all Banks (private)
- Get Accounts by Account Routing Regex
- Get Agent
- Get Agents at Bank
- Get Checkbook orders
- Get Fast Firehose Accounts at Bank
- Get Firehose Accounts at Bank
- Update Account
- Update Account Attribute
- Update Account Label
- Validate and check IBAN
-
-
Account Access
-
Account Access governs access to Bank Accounts by end Users. It is an intersecting entity between tMore...
- Create (DAuth) User with Account Access
- Grant User access to View
- Revoke User access to View
-
-
Counterparty
- Create Counterparty (Explicit)
- Create Counterparty for any account (Explicit)
- Delete Counterparty (Explicit)
- Delete Counterparty for any account (Explicit)
- Get Counterparties (Explicit)
- Get Counterparties for any account (Explicit)
- Get Counterparty by Id for any account (Explicit)
- Get Counterparty by name for any account (Explicit)
- Get Other Account by Id
- Get Other Accounts of one Account
-
Customer
-
The legal entity that has the relationship to the bank. Customers are linked to Users via `User CusMore...
- Create Customer Account Link
-
-
Transaction
-
Transactions are records of successful movements of value into or out of an `Account`. OBP TransacMore...
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
-
-
Account
- Check Available Funds
- Create Account (POST)
- Create Account (PUT)
- Create Account Attribute
- Create or Update Account Attribute Definition
- Delete Account Attribute Definition
- Delete Account Cascade
- Get Account Access by USER_ID
- Get Account Attribute Definition
- Get Account Balances
- Get Account Balances by BANK_ID
- Get Account Balances by BANK_ID
- Get Account Balances by BANK_ID and ACCOUNT_ID through the VIEW_ID
- Get Account by Account Routing
- Get Account by Id (Core)
- Get Account by Id (Core) through the VIEW_ID
- Get Account by Id (Full)
- Get Accounts Held
- Get Accounts Minimal for a Customer
- Get Accounts at Bank
- Get Accounts at Bank (IDs only)
- Get Accounts at Bank (Minimal)
- Get Accounts at all Banks (private)
- Get Accounts by Account Routing Regex
- Get Agent
- Get Agents at Bank
- Get Checkbook orders
- Get Fast Firehose Accounts at Bank
- Get Firehose Accounts at Bank
- Update Account
- Update Account Attribute
- Update Account Label
- Validate and check IBAN
-
Account Access
-
Account Application
- Create Account Application
- Get Account Application by Id
- Get Account Applications
- Update Account Application Status
-
Account Metadata
-
Account Public
-
Counterparty
- Create Counterparty (Explicit)
- Create Counterparty for any account (Explicit)
- Delete Counterparty (Explicit)
- Delete Counterparty for any account (Explicit)
- Get Counterparties (Explicit)
- Get Counterparties for any account (Explicit)
- Get Counterparty by Id for any account (Explicit)
- Get Counterparty by name for any account (Explicit)
- Get Other Account by Id
- Get Other Accounts of one Account
-
Customer
-
Direct Debit
-
Standing Order
-
Transaction
-
View Custom
- Create Custom View
- Create Custom View
- Delete Custom View
- Delete Custom View
- Get Account access for User
- Get Custom View
- Get Views for Account
- Get access
- Update Custom View
- Update Custom View
v5.1.0 filtered by tag: Account (73 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-12-11T21:00:24Z",
"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 (POST)
Create Account at bank specified by BANK_ID.
The User can create an Account for themself - or - the User that has the USER_ID specified in the POST body.
If the POST body USER_ID is specified, the logged in user must have the Role CanCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.
If the POST body USER_ID is not specified, the account will be owned by the logged in User.
The 'product_code' field SHOULD be a product_code from Product.
If the product_code matches a product_code from Product, account attributes will be created that match the Product Attributes.
Note: The Amount MUST be zero.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
amount: 10.12
balance: 10
branch_id: DERBY6
currency: EUR
label: My Account
product_code: 1234BW
scheme: OBP
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
amount: 10.12
balance: 10
branch_id: DERBY6
currency: EUR
label: My Account
name: ACCOUNT_MANAGEMENT_FEE
product_code: 1234BW
scheme: OBP
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":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"account_attributes":[{
"product_code":"1234BW",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23",
"product_instance_code":"LKJL98769F"
}]
}
-
CanCreateAccount
- 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-20006: User is missing one or more roles:
- OBP-30106: Invalid Balance Amount.
- OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00
- OBP-30109: Initial Balance of Account must be Zero (0).
- OBP-30105: Invalid Balance Currency.
- OBP-50000: Unknown Error.
Create Account (PUT)
Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.
The User can create an Account for themself - or - the User that has the USER_ID specified in the POST body.
If the PUT body USER_ID is specified, the logged in user must have the Role canCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.
If the PUT body USER_ID is not specified, the account will be owned by the logged in User.
The 'product_code' field SHOULD be a product_code from Product.
If the 'product_code' matches a product_code from Product, account attributes will be created that match the Product Attributes.
Note: The Amount MUST be zero.
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: OBP
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":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"account_attributes":[{
"product_code":"1234BW",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23",
"product_instance_code":"LKJL98769F"
}]
}
-
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:
Create or Update Account Attribute Definition
Create or Update Account Attribute Definition
The category field must be Account
The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
bank_id: gh.29.uk
can_be_seen_on_views: false
description: Description of the object. Maximum length is 2000. It can be any characters here.
is_active: false
name: ACCOUNT_MANAGEMENT_FEE
type:
{
"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"bank_id":"gh.29.uk",
"name":"SPECIAL_TAX_NUMBER",
"category":"Account",
"type":"STRING",
"description":"description",
"alias":"STRING",
"can_be_seen_on_views":["bank"],
"is_active":true
}
-
CanCreateAccountAttributeDefinitionAtOneBank
- 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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Delete Account Attribute Definition
Delete Account Attribute Definition by ATTRIBUTE_DEFINITION_ID
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
-
CanDeleteAccountAttributeDefinitionAtOneBank
- 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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Delete Account Cascade
Delete an Account Cascade specified by ACCOUNT_ID.
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
JSON response body fields:
-
CanDeleteAccountCascade
- 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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Account Access by USER_ID
Get Account Access by USER_ID
Authentication is Mandatory
URL Parameters:
USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
bank_id: gh.29.uk
view_id: owner
{
"accounts":[{
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"view_id":"owner"
}]
}
-
CanSeeAccountAccessForAnyUser
- 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-20057: User not found by userId.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Account Attribute Definition
Get Account Attribute Definition
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
attributes: attribute value in form of (name, value)
bank_id: gh.29.uk
can_be_seen_on_views: false
description: Description of the object. Maximum length is 2000. It can be any characters here.
is_active: false
name: ACCOUNT_MANAGEMENT_FEE
type:
{
"attributes":[{
"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"bank_id":"gh.29.uk",
"name":"SPECIAL_TAX_NUMBER",
"category":"Account",
"type":"STRING",
"description":"description",
"alias":"STRING",
"can_be_seen_on_views":["bank"],
"is_active":true
}]
}
-
CanGetAccountAttributeDefinitionAtOneBank
- 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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Account Balances
Get the Balances for one Account of the current User at one bank.
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
balances: balances
bank_id: gh.29.uk
currency: EUR
label: My Account
scheme: OBP
type:
{
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"account_routings":[{
"scheme":"accountNumber",
"address":"123456"
}],
"label":"My Account",
"balances":[{
"type":"",
"currency":"EUR",
"amount":"10"
}]
}
- 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-30065: Cannot find account access.
- OBP-50000: Unknown Error.
Get Account Balances by BANK_ID
Get the Balances for the Account specified by BANK_ID.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
amount: 10.12
balances: balances
bank_id: gh.29.uk
currency: EUR
label: My Account
scheme: OBP
type:
{
"accounts":[{
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"account_routings":[{
"scheme":"accountNumber",
"address":"123456"
}],
"label":"My Account",
"balances":[{
"type":"",
"currency":"EUR",
"amount":"10"
}]
}]
}
- 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 Account Balances by BANK_ID
{
"accounts":[{
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"account_routings":[{
"scheme":"accountNumber",
"address":"123456"
}],
"label":"My Account",
"balances":[{
"type":"",
"currency":"EUR",
"amount":"10"
}]
}]
}
- 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 Account Balances by BANK_ID and ACCOUNT_ID through the VIEW_ID
Get the Balances for the Account specified by BANK_ID and ACCOUNT_ID through the VIEW_ID.
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
amount: 10.12
balances: balances
bank_id: gh.29.uk
currency: EUR
label: My Account
scheme: OBP
type:
{
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"account_routings":[{
"scheme":"accountNumber",
"address":"123456"
}],
"label":"My Account",
"balances":[{
"type":"",
"currency":"EUR",
"amount":"10"
}]
}
- 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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-50000: Unknown Error.
Get Account by Account Routing
This endpoint returns the account (if it exists) linked with the provided scheme and address.
The bank_id
field is optional, but if it's not provided, we don't guarantee that the returned account is unique across all the banks.
Example of account routing scheme: IBAN
, "OBP", "AccountNumber", ...
Example of account routing address: DE17500105178275645584
, "321774cc-fccd-11ea-adc1-0242ac120002", "55897106215", ...
Authentication is Mandatory
JSON request body fields:
scheme: OBP
bank_id: gh.29.uk
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
date: 2020-01-27
description: Description of the object. 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: OBP
tags: Create-My-User
type:
user:
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"
}],
"product_code":"1234BW",
"balance":{
"currency":"EUR",
"amount":"0"
},
"views_available":[{
"id":"123",
"short_name":"short_name",
"description":"description",
"is_public":true,
"alias":"None",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_see_bank_account_bank_name":true,
"can_see_bank_account_currency":true,
"can_see_bank_account_iban":true,
"can_see_bank_account_label":true,
"can_see_bank_account_national_identifier":true,
"can_see_bank_account_number":true,
"can_see_bank_account_owners":true,
"can_see_bank_account_swift_bic":true,
"can_see_bank_account_type":true,
"can_see_comments":true,
"can_see_corporate_location":true,
"can_see_image_url":true,
"can_see_images":true,
"can_see_more_info":true,
"can_see_open_corporates_url":true,
"can_see_other_account_bank_name":true,
"can_see_other_account_iban":true,
"can_see_other_account_kind":true,
"can_see_other_account_metadata":true,
"can_see_other_account_national_identifier":true,
"can_see_other_account_number":true,
"can_see_other_account_swift_bic":true,
"can_see_owner_comment":true,
"can_see_physical_location":true,
"can_see_private_alias":true,
"can_see_public_alias":true,
"can_see_tags":true,
"can_see_transaction_amount":true,
"can_see_transaction_balance":true,
"can_see_transaction_currency":true,
"can_see_transaction_description":true,
"can_see_transaction_finish_date":true,
"can_see_transaction_metadata":true,
"can_see_transaction_other_bank_account":true,
"can_see_transaction_start_date":true,
"can_see_transaction_this_bank_account":true,
"can_see_transaction_type":true,
"can_see_url":true,
"can_see_where_tag":true
}],
"bank_id":"gh.29.uk",
"account_routings":[{
"scheme":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"account_attributes":[{
"product_code":"1234BW",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23",
"product_instance_code":"LKJL98769F"
}],
"tags":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"1100-01-01T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}]
}
- 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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_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
- Tags - A list of Tags assigned to this account
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
id: d8839721-ad8f-45dd-9f78-2080414b93f9
label: My Account
product_code: 1234BW
scheme: OBP
{
"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"bank_id":"gh.29.uk",
"label":"My Account",
"number":"546387432",
"product_code":"AC",
"balance":{
"currency":"EUR",
"amount":"0"
},
"account_routings":[{
"scheme":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"views_basic":["owner"]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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 Account by Id (Core) through the VIEW_ID
Information returned about the account through VIEW_ID :
Authentication is Mandatory
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
currency: EUR
id: d8839721-ad8f-45dd-9f78-2080414b93f9
label: My Account
product_code: 1234BW
scheme: OBP
{
"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"bank_id":"gh.29.uk",
"label":"My Account",
"number":"546387432",
"product_code":"AC",
"balance":{
"currency":"EUR",
"amount":"0"
},
"account_routings":[{
"scheme":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"views_basic":["owner"]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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 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 Mandatory
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
date: 2020-01-27
description: Description of the object. 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: OBP
tags: Create-My-User
type:
user:
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"
}],
"product_code":"1234BW",
"balance":{
"currency":"EUR",
"amount":"0"
},
"views_available":[{
"id":"123",
"short_name":"short_name",
"description":"description",
"is_public":true,
"alias":"None",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_see_bank_account_bank_name":true,
"can_see_bank_account_currency":true,
"can_see_bank_account_iban":true,
"can_see_bank_account_label":true,
"can_see_bank_account_national_identifier":true,
"can_see_bank_account_number":true,
"can_see_bank_account_owners":true,
"can_see_bank_account_swift_bic":true,
"can_see_bank_account_type":true,
"can_see_comments":true,
"can_see_corporate_location":true,
"can_see_image_url":true,
"can_see_images":true,
"can_see_more_info":true,
"can_see_open_corporates_url":true,
"can_see_other_account_bank_name":true,
"can_see_other_account_iban":true,
"can_see_other_account_kind":true,
"can_see_other_account_metadata":true,
"can_see_other_account_national_identifier":true,
"can_see_other_account_number":true,
"can_see_other_account_swift_bic":true,
"can_see_owner_comment":true,
"can_see_physical_location":true,
"can_see_private_alias":true,
"can_see_public_alias":true,
"can_see_tags":true,
"can_see_transaction_amount":true,
"can_see_transaction_balance":true,
"can_see_transaction_currency":true,
"can_see_transaction_description":true,
"can_see_transaction_finish_date":true,
"can_see_transaction_metadata":true,
"can_see_transaction_other_bank_account":true,
"can_see_transaction_start_date":true,
"can_see_transaction_this_bank_account":true,
"can_see_transaction_type":true,
"can_see_url":true,
"can_see_where_tag":true
}],
"bank_id":"gh.29.uk",
"account_routings":[{
"scheme":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"account_attributes":[{
"product_code":"1234BW",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23",
"product_instance_code":"LKJL98769F"
}],
"tags":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"1100-01-01T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}]
}
- 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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- 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: OBP
{
"accounts":[{
"id":"12314",
"label":"My Account",
"bank_id":"123",
"number":"123",
"account_routings":[{
"scheme":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}]
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Accounts Minimal for a Customer
Get Accounts Minimal by CUSTOMER_ID
Authentication is Mandatory
URL Parameters:
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
bank_id: gh.29.uk
view_id: owner
{
"accounts":[{
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"view_id":"owner"
}]
}
-
CanGetAccountsMinimalForCustomerAtAnyBank
- 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-30002: Customer not found. Please specify a valid value for CUSTOMER_NUMBER.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Accounts at Bank
Returns the list of accounts at BANK_ID that the user has access to.
For each account the API returns the account ID and the views available to the user..
Each account must have at least one private View.
optional request parameters for filter with attributes
URL params example: /banks/some-bank-id/accounts?&limit=50&offset=1
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-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 (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: Description of the object. Maximum length is 2000. It can be any characters here.
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_public: false
label: My Account
scheme: OBP
{
"accounts":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"String",
"bank_id":"gh.29.uk",
"account_type":"330",
"account_routings":[{
"scheme":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"views":[{
"id":"owner",
"short_name":"owner",
"description":"This view is for the owner for the account.",
"is_public":false
}]
}]
}
- 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: Description of the object. Maximum length is 2000. It can be any characters here.
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_public: false
label: My Account
scheme: OBP
{
"accounts":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"String",
"bank_id":"gh.29.uk",
"account_type":"330",
"account_routings":[{
"scheme":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"views":[{
"id":"owner",
"short_name":"owner",
"description":"This view is for the owner for the account.",
"is_public":false
}]
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Accounts by Account Routing Regex
This endpoint returns an array of accounts matching the provided routing scheme and the routing address regex.
The bank_id
field is optional.
Example of account routing scheme: IBAN
, OBP
, AccountNumber
, ...
Example of account routing address regex: DE175.*
, 55897106215-[A-Z]{3}
, ...
This endpoint can be used to retrieve multiples accounts matching a same account routing address pattern.
For example, if you want to link multiple accounts having different currencies, you can create an account
with 123456789-EUR
as Account Number and an other account with 123456789-USD
as Account Number.
So we can identify the Account Number as 123456789
, so to get all the accounts with the same account number
and the different currencies, we can use this body in the request :
{
"bank_id": "BANK_ID",
"account_routing": {
"scheme": "AccountNumber",
"address": "123456789-[A-Z]{3}"
}
}
This request will returns the accounts matching the routing address regex (123456789-EUR
and 123456789-USD
).
Authentication is Mandatory
JSON request body fields:
scheme: OBP
bank_id: gh.29.uk
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
date: 2020-01-27
description: Description of the object. 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: OBP
tags: Create-My-User
type:
user:
value: 5987953
product_instance_code: product_instance_code
{
"accounts":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"NoneLabel",
"number":"123",
"owners":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}],
"product_code":"1234BW",
"balance":{
"currency":"EUR",
"amount":"0"
},
"views_available":[{
"id":"123",
"short_name":"short_name",
"description":"description",
"is_public":true,
"alias":"None",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_see_bank_account_bank_name":true,
"can_see_bank_account_currency":true,
"can_see_bank_account_iban":true,
"can_see_bank_account_label":true,
"can_see_bank_account_national_identifier":true,
"can_see_bank_account_number":true,
"can_see_bank_account_owners":true,
"can_see_bank_account_swift_bic":true,
"can_see_bank_account_type":true,
"can_see_comments":true,
"can_see_corporate_location":true,
"can_see_image_url":true,
"can_see_images":true,
"can_see_more_info":true,
"can_see_open_corporates_url":true,
"can_see_other_account_bank_name":true,
"can_see_other_account_iban":true,
"can_see_other_account_kind":true,
"can_see_other_account_metadata":true,
"can_see_other_account_national_identifier":true,
"can_see_other_account_number":true,
"can_see_other_account_swift_bic":true,
"can_see_owner_comment":true,
"can_see_physical_location":true,
"can_see_private_alias":true,
"can_see_public_alias":true,
"can_see_tags":true,
"can_see_transaction_amount":true,
"can_see_transaction_balance":true,
"can_see_transaction_currency":true,
"can_see_transaction_description":true,
"can_see_transaction_finish_date":true,
"can_see_transaction_metadata":true,
"can_see_transaction_other_bank_account":true,
"can_see_transaction_start_date":true,
"can_see_transaction_this_bank_account":true,
"can_see_transaction_type":true,
"can_see_url":true,
"can_see_where_tag":true
}],
"bank_id":"gh.29.uk",
"account_routings":[{
"scheme":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"account_attributes":[{
"product_code":"1234BW",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23",
"product_instance_code":"LKJL98769F"
}],
"tags":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"1100-01-01T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}]
}]
}
- 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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-50000: Unknown Error.
Get Agent
Get Agent.
Authentication is Mandatory
URL Parameters:
AGENT_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
BANK_ID: gh.29.uk
JSON response body fields:
agent_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
agent_number: 5987953
bank_id: gh.29.uk
currency: EUR
is_confirmed_agent: is_confirmed_agent
is_pending_agent: is_pending_agent
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
{
"agent_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"bank_id":"gh.29.uk",
"legal_name":"Eveline Tripman",
"mobile_phone_number":"+49 30 901820",
"agent_number":"5987953",
"currency":"EUR",
"is_confirmed_agent":false,
"is_pending_agent":true
}
- 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-30201: Agent not found. Please specify a valid value for AGENT_ID.
- OBP-30325: Agent Account Link not found.
- OBP-50000: Unknown Error.
Get Agents at Bank
Get Agents at Bank.
Authentication is Optional
Possible custom url parameters for pagination:
- limit=NUMBER ==> default value: 50
- offset=NUMBER ==> default value: 0
eg1:?limit=100&offset=0
- sort_direction=ASC/DESC ==> default value: DESC.
eg2:?limit=100&offset=0&sort_direction=ASC
- from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).
- to_date=DATE => example value: 2024-12-11T21:00:28.217Z. NOTE! The default value is now (2024-12-11T21:00:28.217Z).
Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
agent_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
agent_number: 5987953
agents: agents
legal_name: Eveline Tripman
{
"agents":[{
"agent_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"legal_name":"Eveline Tripman",
"agent_number":"5987953"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30326: Agents not found.
- 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: OBP
{
"account":{
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"account_type":"330",
"account_routings":[{
"scheme":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"branch_routings":[{
"scheme":"OBP",
"address":"DERBY6"
}]
},
"orders":[{
"order":{
"order_id":"xjksajfkj",
"order_date":"07082013",
"number_of_checkbooks":"4",
"distribution_channel":"1201",
"status":"2",
"first_check_number":"5165276",
"shipping_code":"1"
}
}]
}
- 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 Fast Firehose Accounts at Bank
This endpoint allows bulk access to accounts.
optional pagination parameters for filter with accounts
Possible custom url parameters for pagination:
- limit=NUMBER ==> default value: 50
- offset=NUMBER ==> default value: 0
eg1:?limit=100&offset=0
- sort_direction=ASC/DESC ==> default value: DESC.
eg2:?limit=100&offset=0&sort_direction=ASC
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
amount: 10.12
balance: 10
bank_id: gh.29.uk
code: 125
currency: EUR
id: d8839721-ad8f-45dd-9f78-2080414b93f9
label: My Account
product_code: 1234BW
provider: ETHEREUM
type:
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
user_name: felixsmith
value: 5987953
{
"accounts":[{
"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"bank_id":"gh.29.uk",
"label":"My Account",
"number":"",
"owners":[{
"user_id":"b27327a2-a822-41e5-a909-0150da688939",
"provider":"https://finx22openplatform.fintech-galaxy.com,user_name:synth_user_1_54891",
"user_name":""
}],
"product_code":"1234BW",
"balance":{
"currency":"EUR",
"amount":"0"
},
"account_routings":[{
"bank_id":"bisb.com",
"account_id":"c590e38e-847c-466f-9a62-f2ad67daf106"
}],
"account_attributes":[{
"type":"INTEGER",
"code":"Loan1",
"value":"0"
},{
"type":"STRING",
"code":"Loan1",
"value":"4421.783"
}]
}]
}
-
CanUseAccountFirehoseAtAnyBank
- Please login to request this Role
-
CanUseAccountFirehose
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
Get Firehose Accounts at Bank
Get Accounts which have a firehose view assigned to them.
This endpoint allows bulk access to accounts.
Requires the CanUseFirehoseAtAnyBank Role
To be shown on the list, each Account must have a firehose View linked to it.
A firehose view has is_firehose = true
For VIEW_ID try 'owner'
optional request parameters for filter with attributes
URL params example:
/banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1
to invalid Browser cache, add timestamp query parameter as follow, the parameter name must be _timestamp_
URL params example:
/banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1&_timestamp_=1596762180358
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
product_code: 1234BW
provider: ETHEREUM
scheme: OBP
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"
}],
"product_code":"1234BW",
"balance":{
"currency":"EUR",
"amount":"0"
},
"account_routings":[{
"scheme":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
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: OBP
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:
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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-50000: Unknown Error.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- user does not have access to owner view on account
Validate and check IBAN
Validate and check IBAN for errors
Authentication is Optional
JSON request body fields:
JSON response body fields:
attributes: attribute value in form of (name, value)
bank:
bank_routings: bank routing in form of (scheme, address)
branch: branch
city:
country: Germany
is_valid: is_valid
name: ACCOUNT_MANAGEMENT_FEE
scheme: OBP
value: 5987953
{
"is_valid":true,
"details":{
"bank_routings":[{
"scheme":"BIC",
"address":"SOGEDEFF"
}],
"bank":"Societe Generale",
"branch":"",
"address":"Neue mainzer strasse 46-50",
"city":"Frankfurt am Main",
"postcode":"60311",
"phone":"",
"country":"Germany",
"attributes":[{
"name":"country_iso",
"value":""
},{
"name":"sepa_credit_transfer",
"value":"YES"
},{
"name":"sepa_direct_debit",
"value":"YES"
},{
"name":"sepa_sdd_core",
"value":"YES"
},{
"name":"sepa_b2b",
"value":"YES"
},{
"name":"sepa_card_clearing",
"value":"YES"
}]
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
Create (DAuth) User with Account Access
This endpoint is used as part of the DAuth solution to grant access to account and transaction data to a smart contract on the blockchain.
Put the smart contract address in username
For provider use "dauth"
This endpoint will create the (DAuth) User with username and provider if the User does not already exist.
Authentication is Mandatory and the logged in user needs to be account holder.
For information about DAuth see below:
DAuth
DAuth Introduction, Setup and Usage
DAuth is an experimental authentication mechanism that aims to pin an ethereum or other blockchain Smart Contract to an OBP "User".
In the future, it might be possible to be more specific and pin specific actors (wallets) that are acting within the smart contract, but so far, one smart contract acts on behalf of one User.
Thus, if a smart contract "X" calls the OBP API using the DAuth header, OBP will get or create a user called X and the call will proceed in the context of that User "X".
DAuth is invoked by the REST client (caller) including a specific header (see step 3 below) in any OBP REST call.
When OBP receives the DAuth token, it creates or gets a User with a username based on the smart_contract_address and the provider based on the network_name. The combination of username and provider is unique in OBP.
If you are calling OBP-API via an API3 Airnode, the Airnode will take care of constructing the required header.
When OBP detects a DAuth header / token it first checks if the Consumer is allowed to make such a call. OBP will validate the Consumer ip address and signature etc.
Note: The DAuth flow does not require an explicit POST like Direct Login to create the token.
Permissions may be assigned to an OBP User at any time, via the UserAuthContext, Views, Entitlements to Roles or Consents.
Note: DAuth is NOT enabled on this instance!
Note: The DAuth client is responsible for creating a token which will be trusted by OBP absolutely!
To use DAuth:
1) Configure OBP API to accept DAuth.
Set up properties in your props file
# -- DAuth --------------------------------------
# Define secret used to validate JWT token
# jwt.public_key_rsa=path-to-the-pem-file
# Enable/Disable DAuth communication at all
# In case isn't defined default value is false
# allow_dauth=false
# Define comma separated list of allowed IP addresses
# dauth.host=127.0.0.1
# -------------------------------------- DAuth--
Please keep in mind that property jwt.public_key_rsa is used to validate JWT token to check it is not changed or corrupted during transport.
2) Create / have access to a JWT
The following videos are available:
* DAuth in local environment
HEADER:ALGORITHM & TOKEN TYPE
{
"alg": "RS256",
"typ": "JWT"
}
PAYLOAD:DATA
{
"smart_contract_address": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",
"network_name": "AIRNODE.TESTNET.ETHEREUM",
"msg_sender": "0xe12340927f1725E7734CE288F8367e1Bb143E90fhku767",
"consumer_key": "0x1234a4ec31e89cea54d1f125db7536e874ab4a96b4d4f6438668b6bb10a6adb",
"timestamp": "2021-11-04T14:13:40Z",
"request_id": "0Xe876987694328763492876348928736497869273649"
}
VERIFY SIGNATURE
RSASHA256(
base64UrlEncode(header) + "." +
base64UrlEncode(payload),
) your-RSA-key-pair
Here is an example token:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k
3) Try a REST call using the header
Using your favorite http client:
GET https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current
Body
Leave Empty!
Headers:
DAuth: your-jwt-from-step-above
Here is it all together:
GET https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current HTTP/1.1
Host: localhost:8080
User-Agent: curl/7.47.0
Accept: /
DAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k
CURL example
curl -v -H 'DAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k' https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current
You should receive a response like:
{
"user_id": "4c4d3175-1e5c-4cfd-9b08-dcdc209d8221",
"email": "",
"provider_id": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",
"provider": "ETHEREUM",
"username": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",
"entitlements": {
"list": []
}
}
Under the hood
The file, dauth.scala handles the DAuth,
We:
-> Check if Props allow_dauth is true
-> Check if DAuth header exists
-> Check if getRemoteIpAddress is OK
-> Look for "token"
-> parse the JWT token and getOrCreate the user
-> get the data of the user
More information
Parameter names and values are case sensitive.
Each parameter MUST NOT appear more than once per request.
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON request body fields:
is_system: true
provider: ETHEREUM
username: felixsmith
view_id: owner
JSON response body fields:
can_add_counterparty: false
can_add_image_url: false
can_add_more_info: false
can_add_tag: false
can_add_transaction_request_to_any_account:
can_add_transaction_request_to_own_account:
can_create_direct_debit: false
can_delete_corporate_location: false
can_delete_image: false
can_delete_where_tag: false
can_edit_owner_comment: false
can_query_available_funds: false
can_see_bank_account_bank_name: false
can_see_bank_account_credit_limit: 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_routing_address:
can_see_bank_account_routing_scheme:
can_see_bank_account_swift_bic:
can_see_bank_routing_address: false
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_routing_address: false
can_see_other_account_routing_scheme:
can_see_other_account_swift_bic: false
can_see_other_bank_routing_address:
can_see_other_bank_routing_scheme:
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
description: Description of the object. 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
is_system: true
[{
"id":"1234",
"short_name":"short_name",
"description":"description",
"metadata_view":"owner",
"is_public":true,
"is_system":true,
"alias":"No",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_add_counterparty":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_query_available_funds":true,
"can_see_bank_account_bank_name":true,
"can_see_bank_account_currency":true,
"can_see_bank_account_iban":true,
"can_see_bank_account_label":true,
"can_see_bank_account_national_identifier":true,
"can_see_bank_account_number":true,
"can_see_bank_account_owners":true,
"can_see_bank_account_swift_bic":true,
"can_see_bank_account_type":true,
"can_see_comments":true,
"can_see_corporate_location":true,
"can_see_image_url":true,
"can_see_images":true,
"can_see_more_info":true,
"can_see_open_corporates_url":true,
"can_see_other_account_bank_name":true,
"can_see_other_account_iban":true,
"can_see_other_account_kind":true,
"can_see_other_account_metadata":true,
"can_see_other_account_national_identifier":true,
"can_see_other_account_number":true,
"can_see_other_account_swift_bic":true,
"can_see_owner_comment":true,
"can_see_physical_location":true,
"can_see_private_alias":true,
"can_see_public_alias":true,
"can_see_tags":true,
"can_see_transaction_amount":true,
"can_see_transaction_balance":true,
"can_see_transaction_currency":true,
"can_see_transaction_description":true,
"can_see_transaction_finish_date":true,
"can_see_transaction_metadata":true,
"can_see_transaction_other_bank_account":true,
"can_see_transaction_start_date":true,
"can_see_transaction_this_bank_account":true,
"can_see_transaction_type":true,
"can_see_url":true,
"can_see_where_tag":true,
"can_see_bank_routing_scheme":true,
"can_see_bank_routing_address":true,
"can_see_bank_account_routing_scheme":true,
"can_see_bank_account_routing_address":true,
"can_see_other_bank_routing_scheme":true,
"can_see_other_bank_routing_address":true,
"can_see_other_account_routing_scheme":true,
"can_see_other_account_routing_address":true,
"can_add_transaction_request_to_own_account":true,
"can_add_transaction_request_to_any_account":true,
"can_see_bank_account_credit_limit":true,
"can_create_direct_debit":true,
"can_create_standing_order":true
}]
- 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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-20084: The current source view.can_grant_access_to_views does not contains target view.
- OBP-20085: The current source view.can_grant_access_to_custom_views is false.
- OBP-10001: Incorrect json format.
- OBP-30252: System view not found. Please specify a valid value for VIEW_ID
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-30063: Cannot grant account access.
- OBP-50000: Unknown Error.
Grant User access to View
Grants the User identified by USER_ID access to the view identified.
Authentication is Mandatory and the user needs to be account holder.
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON request body fields:
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
view_id: owner
JSON response body fields:
can_add_counterparty: false
can_add_image_url: false
can_add_more_info: false
can_add_tag: false
can_add_transaction_request_to_any_account:
can_add_transaction_request_to_own_account:
can_create_direct_debit: false
can_delete_corporate_location: false
can_delete_image: false
can_delete_where_tag: false
can_edit_owner_comment: false
can_query_available_funds: false
can_see_bank_account_bank_name: false
can_see_bank_account_credit_limit: 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_routing_address:
can_see_bank_account_routing_scheme:
can_see_bank_account_swift_bic:
can_see_bank_routing_address: false
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_routing_address: false
can_see_other_account_routing_scheme:
can_see_other_account_swift_bic: false
can_see_other_bank_routing_address:
can_see_other_bank_routing_scheme:
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
description: Description of the object. 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
is_system: true
{
"id":"1234",
"short_name":"short_name",
"description":"description",
"metadata_view":"owner",
"is_public":true,
"is_system":true,
"alias":"No",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_add_counterparty":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_query_available_funds":true,
"can_see_bank_account_bank_name":true,
"can_see_bank_account_currency":true,
"can_see_bank_account_iban":true,
"can_see_bank_account_label":true,
"can_see_bank_account_national_identifier":true,
"can_see_bank_account_number":true,
"can_see_bank_account_owners":true,
"can_see_bank_account_swift_bic":true,
"can_see_bank_account_type":true,
"can_see_comments":true,
"can_see_corporate_location":true,
"can_see_image_url":true,
"can_see_images":true,
"can_see_more_info":true,
"can_see_open_corporates_url":true,
"can_see_other_account_bank_name":true,
"can_see_other_account_iban":true,
"can_see_other_account_kind":true,
"can_see_other_account_metadata":true,
"can_see_other_account_national_identifier":true,
"can_see_other_account_number":true,
"can_see_other_account_swift_bic":true,
"can_see_owner_comment":true,
"can_see_physical_location":true,
"can_see_private_alias":true,
"can_see_public_alias":true,
"can_see_tags":true,
"can_see_transaction_amount":true,
"can_see_transaction_balance":true,
"can_see_transaction_currency":true,
"can_see_transaction_description":true,
"can_see_transaction_finish_date":true,
"can_see_transaction_metadata":true,
"can_see_transaction_other_bank_account":true,
"can_see_transaction_start_date":true,
"can_see_transaction_this_bank_account":true,
"can_see_transaction_type":true,
"can_see_url":true,
"can_see_where_tag":true,
"can_see_bank_routing_scheme":true,
"can_see_bank_routing_address":true,
"can_see_bank_account_routing_scheme":true,
"can_see_bank_account_routing_address":true,
"can_see_other_bank_routing_scheme":true,
"can_see_other_bank_routing_address":true,
"can_see_other_account_routing_scheme":true,
"can_see_other_account_routing_address":true,
"can_add_transaction_request_to_own_account":true,
"can_add_transaction_request_to_any_account":true,
"can_see_bank_account_credit_limit":true,
"can_create_direct_debit":true,
"can_create_standing_order":true
}
- 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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-20084: The current source view.can_grant_access_to_views does not contains target view.
- OBP-20085: The current source view.can_grant_access_to_custom_views is false.
- OBP-10001: Incorrect json format.
- OBP-20005: User not found. Please specify a valid value for USER_ID.
- OBP-30252: System view not found. Please specify a valid value for VIEW_ID
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-30063: Cannot grant account access.
- OBP-50000: Unknown Error.
Revoke User access to View
Revoke the User identified by USER_ID access to the view identified.
Authentication is Mandatory.
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON request body fields:
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
view_id: owner
JSON response body fields:
{
"revoked":true
}
- 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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-20087: The current source view.can_revoke_access_to_custom_views is false.
- OBP-20086: The current source view.can_revoke_access_to_views does not contains target view.
- OBP-10001: Incorrect json format.
- OBP-20005: User not found. Please specify a valid value for USER_ID.
- OBP-30252: System view not found. Please specify a valid value for VIEW_ID
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-30064: Cannot revoke account access.
- OBP-30065: Cannot find account access.
- OBP-50000: Unknown Error.
Create Account Application
Create Account Application
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
product_code: 1234BW
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_application: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2023-12-11T21:00:24.360Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
product_code: 1234BW
provider: ETHEREUM
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
user:
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
username: felixsmith
{
"account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
"product_code":"1234BW",
"user":{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email":"felixsmith@example.com",
"provider_id":"Chris",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
},
"customer":{
"bank_id":"gh.29.uk",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"customer_number":"5987953",
"legal_name":"Eveline Tripman",
"mobile_phone_number":"+44 07972 444 876",
"email":"felixsmith@example.com",
"face_image":{
"url":"www.openbankproject",
"date":"1100-01-01T00:00:00Z"
},
"date_of_birth":"1100-01-01T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["1100-01-01T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":false,
"last_ok_date":"2023-12-11T21:00:24Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
},
"date_of_application":"1100-01-01T00:00:00Z",
"status":"REQUESTED"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
Get Account Application by Id
Get the Account Application.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_application: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2023-12-11T21:00:24.360Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
product_code: 1234BW
provider: ETHEREUM
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
user:
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
username: felixsmith
{
"account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
"product_code":"1234BW",
"user":{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email":"felixsmith@example.com",
"provider_id":"Chris",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
},
"customer":{
"bank_id":"gh.29.uk",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"customer_number":"5987953",
"legal_name":"Eveline Tripman",
"mobile_phone_number":"+44 07972 444 876",
"email":"felixsmith@example.com",
"face_image":{
"url":"www.openbankproject",
"date":"1100-01-01T00:00:00Z"
},
"date_of_birth":"1100-01-01T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["1100-01-01T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":false,
"last_ok_date":"2023-12-11T21:00:24Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
},
"date_of_application":"1100-01-01T00:00:00Z",
"status":"REQUESTED"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Account Applications
Get the Account Applications.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_application: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2023-12-11T21:00:24.360Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
product_code: 1234BW
provider: ETHEREUM
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
user:
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
username: felixsmith
{
"account_applications":[{
"account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
"product_code":"1234BW",
"user":{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email":"felixsmith@example.com",
"provider_id":"Chris",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
},
"customer":{
"bank_id":"gh.29.uk",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"customer_number":"5987953",
"legal_name":"Eveline Tripman",
"mobile_phone_number":"+44 07972 444 876",
"email":"felixsmith@example.com",
"face_image":{
"url":"www.openbankproject",
"date":"1100-01-01T00:00:00Z"
},
"date_of_birth":"1100-01-01T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["1100-01-01T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":false,
"last_ok_date":"2023-12-11T21:00:24Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
},
"date_of_application":"1100-01-01T00:00:00Z",
"status":"REQUESTED"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Update Account Application Status
Update an Account Application status
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
amount: 10.12
bank_id: gh.29.uk
branch_id: DERBY6
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date: 2020-01-27
date_of_application: 2020-01-27
date_of_birth: 2018-03-09
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2023-12-11T21:00:24.360Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name_suffix: Sr
product_code: 1234BW
provider: ETHEREUM
relationship_status: single
title: Dr.
url: http://www.example.com/id-docs/123/image.png
user:
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
username: felixsmith
{
"account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
"product_code":"1234BW",
"user":{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email":"felixsmith@example.com",
"provider_id":"Chris",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
},
"customer":{
"bank_id":"gh.29.uk",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"customer_number":"5987953",
"legal_name":"Eveline Tripman",
"mobile_phone_number":"+44 07972 444 876",
"email":"felixsmith@example.com",
"face_image":{
"url":"www.openbankproject",
"date":"1100-01-01T00:00:00Z"
},
"date_of_birth":"1100-01-01T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["1100-01-01T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":false,
"last_ok_date":"2023-12-11T21:00:24Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
},
"date_of_application":"1100-01-01T00:00:00Z",
"status":"REQUESTED"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Create a tag on account
Posts a tag about an account ACCOUNT_ID on a view VIEW_ID.
Authentication is Mandatory
Authentication is required as the tag is linked with the user.
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON request body fields:
value: 5987953
JSON response body fields:
date: 2020-01-27
id: d8839721-ad8f-45dd-9f78-2080414b93f9
provider: ETHEREUM
user:
value: 5987953
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"1100-01-01T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}
- 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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-10001: Incorrect json format.
- OBP-30022: The current view does not have the permission:
- OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-50000: Unknown Error.
Delete a tag on account
Deletes the tag TAG_ID about the account ACCOUNT_ID made on view.
Authentication is Mandatory
Authentication is required as the tag is linked with the user.
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON response body fields:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-50000: Unknown Error.
Get tags on account
Returns the account ACCOUNT_ID tags made on a view (VIEW_ID).
Authentication is Mandatory
Authentication is required as the tag is linked with the user.
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON response body fields:
date: 2020-01-27
id: d8839721-ad8f-45dd-9f78-2080414b93f9
provider: ETHEREUM
tags: Create-My-User
user:
value: 5987953
{
"tags":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"1100-01-01T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}]
}
- 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-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 Public Account by Id
Returns information about an account that has a public view.
The account is specified by ACCOUNT_ID. The information is moderated by the view specified by VIEW_ID.
- Number
- Owners
- Type
- Balance
- Routing
PSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
This call provides balance and other account information via delegated authentication using OAuth.
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
currency: EUR
id: d8839721-ad8f-45dd-9f78-2080414b93f9
label: My Account
name: ACCOUNT_MANAGEMENT_FEE
product_code: 1234BW
provider: ETHEREUM
scheme: OBP
type:
value: 5987953
product_instance_code: product_instance_code
{
"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"bank_id":"gh.29.uk",
"label":"My Account",
"number":"",
"owners":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}],
"type":"",
"balance":{
"currency":"EUR",
"amount":"0"
},
"account_routings":[{
"scheme":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"account_rules":[{
"scheme":"OVERDRAFT",
"value":"10"
}],
"account_attributes":[{
"product_code":"1234BW",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23",
"product_instance_code":"LKJL98769F"
}]
}
- 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-50000: Unknown Error.
Get Public Accounts at Bank
Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.
Authentication is Optional
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-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
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-30066: Could not get accounts.
- OBP-50000: Unknown Error.
Create Counterparty (Explicit)
Create Counterparty (Explicit) for an Account.
In OBP, there are two types of Counterparty.
-
Explicit Counterparties (those here) which we create explicitly and are used in COUNTERPARTY Transaction Requests
-
Implicit Counterparties (AKA Other Accounts) which are generated automatically from the other sides of Transactions.
Explicit 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 : the human readable name (e.g. Piano teacher, Miss Nipa)
description : the human readable name (e.g. Piano teacher, Miss Nipa)
currency : counterparty account currency (e.g. EUR, GBP, USD, ...)
bank_routing_scheme : eg: bankId or bankCode or any other strings
bank_routing_address : eg: gh.29.uk
, must be valid sandbox bankIds
account_routing_scheme : eg: AccountId or AccountNumber or any other strings
account_routing_address : eg: 1d65db7c-a7b2-4839-af41-95
, must be valid accountIds
other_account_secondary_routing_scheme : eg: IBAN or any other strings
other_account_secondary_routing_address : if it is an IBAN, it should be unique for each counterparty.
other_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode.
other_branch_routing_address : eg: branch-id-123
or you can leave it empty, not useful in sandbox mode.
is_beneficiary : must be set to true
in order to send payments to this counterparty
bespoke: It supports a list of key-value, you can add it to the counterparty.
bespoke.key : any info-key you want to add to this counterparty
bespoke.value : any info-value you want to add to this counterparty
The view specified by VIEW_ID must have the canAddCounterparty permission
A minimal example for TransactionRequestType == COUNTERPARTY
{
"name": "Tesobe1",
"description": "Good Company",
"currency": "EUR",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"is_beneficiary": true,
"other_account_secondary_routing_scheme": "",
"other_account_secondary_routing_address": "",
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}
A minimal example for TransactionRequestType == SEPA
{
"name": "Tesobe2",
"description": "Good Company",
"currency": "EUR",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"other_account_secondary_routing_scheme": "IBAN",
"other_account_secondary_routing_address": "DE89 3704 0044 0532 0130 00",
"is_beneficiary": true,
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON request body fields:
currency: EUR
description: Description of the object. Maximum length is 2000. It can be any characters here.
is_beneficiary: false
key: CustomerNumber
name: ACCOUNT_MANAGEMENT_FEE
other_account_routing_address:
other_account_secondary_routing_address:
other_account_secondary_routing_scheme:
value: 5987953
JSON response body fields:
counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
currency: EUR
date: 2020-01-27
description: Description of the object. Maximum length is 2000. It can be any characters here.
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_beneficiary: false
key: CustomerNumber
latitude: 38.8951
longitude: -77.0364
more_info: More information about this fee
name: ACCOUNT_MANAGEMENT_FEE
other_account_routing_address:
other_account_secondary_routing_address:
other_account_secondary_routing_scheme:
provider: ETHEREUM
url: http://www.example.com/id-docs/123/image.png
user:
username: felixsmith
value: 5987953
{
"name":"CounterpartyName",
"description":"My landlord",
"currency":"EUR",
"created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"this_bank_id":"gh.29.uk",
"this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"this_view_id":"owner",
"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"other_bank_routing_scheme":"OBP",
"other_bank_routing_address":"gh.29.uk",
"other_branch_routing_scheme":"OBP",
"other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
"other_account_routing_scheme":"OBP",
"other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
"other_account_secondary_routing_scheme":"IBAN",
"other_account_secondary_routing_address":"DE89370400440532013000",
"is_beneficiary":true,
"bespoke":[{
"key":"englishName",
"value":"english Name"
}],
"metadata":{
"public_alias":"String",
"more_info":"String",
"url":"String",
"image_url":"String",
"open_corporates_url":"String",
"corporate_location":{
"latitude":11.45,
"longitude":11.45,
"date":"1100-01-01T00:00:00Z",
"user":{
"id":"123",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
}
},
"physical_location":{
"latitude":11.45,
"longitude":11.45,
"date":"1100-01-01T00:00:00Z",
"user":{
"id":"123",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
}
},
"private_alias":"String"
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-10001: Incorrect json format.
- OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
- 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.
Create Counterparty for any account (Explicit)
Create Counterparty for any Account. (Explicit)
In OBP, there are two types of Counterparty.
-
Explicit Counterparties (those here) which we create explicitly and are used in COUNTERPARTY Transaction Requests
-
Implicit Counterparties (AKA Other Accounts) which are generated automatically from the other sides of Transactions.
Explicit 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 : the human readable name (e.g. Piano teacher, Miss Nipa)
description : the human readable name (e.g. Piano teacher, Miss Nipa)
currency : counterparty account currency (e.g. EUR, GBP, USD, ...)
bank_routing_scheme : eg: bankId or bankCode or any other strings
bank_routing_address : eg: gh.29.uk
, must be valid sandbox bankIds
account_routing_scheme : eg: AccountId or AccountNumber or any other strings
account_routing_address : eg: 1d65db7c-a7b2-4839-af41-95
, must be valid accountIds
other_account_secondary_routing_scheme : eg: IBAN or any other strings
other_account_secondary_routing_address : if it is an IBAN, it should be unique for each counterparty.
other_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode.
other_branch_routing_address : eg: branch-id-123
or you can leave it empty, not useful in sandbox mode.
is_beneficiary : must be set to true
in order to send payments to this counterparty
bespoke: It supports a list of key-value, you can add it to the counterparty.
bespoke.key : any info-key you want to add to this counterparty
bespoke.value : any info-value you want to add to this counterparty
The view specified by VIEW_ID must have the canAddCounterparty permission
A minimal example for TransactionRequestType == COUNTERPARTY
{
"name": "Tesobe1",
"description": "Good Company",
"currency": "EUR",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"is_beneficiary": true,
"other_account_secondary_routing_scheme": "",
"other_account_secondary_routing_address": "",
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}
A minimal example for TransactionRequestType == SEPA
{
"name": "Tesobe2",
"description": "Good Company",
"currency": "EUR",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"other_account_secondary_routing_scheme": "IBAN",
"other_account_secondary_routing_address": "DE89 3704 0044 0532 0130 00",
"is_beneficiary": true,
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON request body fields:
currency: EUR
description: Description of the object. Maximum length is 2000. It can be any characters here.
is_beneficiary: false
key: CustomerNumber
name: ACCOUNT_MANAGEMENT_FEE
other_account_routing_address:
other_account_secondary_routing_address:
other_account_secondary_routing_scheme:
value: 5987953
JSON response body fields:
counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
currency: EUR
date: 2020-01-27
description: Description of the object. Maximum length is 2000. It can be any characters here.
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_beneficiary: false
key: CustomerNumber
latitude: 38.8951
longitude: -77.0364
more_info: More information about this fee
name: ACCOUNT_MANAGEMENT_FEE
other_account_routing_address:
other_account_secondary_routing_address:
other_account_secondary_routing_scheme:
provider: ETHEREUM
url: http://www.example.com/id-docs/123/image.png
user:
username: felixsmith
value: 5987953
{
"name":"CounterpartyName",
"description":"My landlord",
"currency":"EUR",
"created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"this_bank_id":"gh.29.uk",
"this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"this_view_id":"owner",
"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"other_bank_routing_scheme":"OBP",
"other_bank_routing_address":"gh.29.uk",
"other_branch_routing_scheme":"OBP",
"other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
"other_account_routing_scheme":"OBP",
"other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
"other_account_secondary_routing_scheme":"IBAN",
"other_account_secondary_routing_address":"DE89370400440532013000",
"is_beneficiary":true,
"bespoke":[{
"key":"englishName",
"value":"english Name"
}],
"metadata":{
"public_alias":"String",
"more_info":"String",
"url":"String",
"image_url":"String",
"open_corporates_url":"String",
"corporate_location":{
"latitude":11.45,
"longitude":11.45,
"date":"1100-01-01T00:00:00Z",
"user":{
"id":"123",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
}
},
"physical_location":{
"latitude":11.45,
"longitude":11.45,
"date":"1100-01-01T00:00:00Z",
"user":{
"id":"123",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
}
},
"private_alias":"String"
}
}
-
CanCreateCounterparty
- Please login to request this Role
-
CanCreateCounterpartyAtAnyBank
- 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-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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
- 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.
- OBP-20006: User is missing one or more roles:
Delete Counterparty (Explicit)
Delete Counterparty (Explicit) for an Account.
and also delete the Metadata for its counterparty.
need the view permission can_delete_counterparty
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
COUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-50000: Unknown Error.
Delete Counterparty for any account (Explicit)
Delete Counterparty (Explicit) for any account
and also delete the Metadata for its counterparty.
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
COUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
VIEW_ID: owner
JSON response body fields:
-
CanDeleteCounterparty
- Please login to request this Role
-
CanDeleteCounterpartyAtAnyBank
- 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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30001: Bank not found. Please specify a valid value for BANK_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-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Counterparties (Explicit)
Get the Counterparties (Explicit) for the account / view.
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON response body fields:
counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
currency: EUR
description: Description of the object. Maximum length is 2000. It can be any characters here.
is_beneficiary: false
key: CustomerNumber
name: ACCOUNT_MANAGEMENT_FEE
other_account_routing_address:
other_account_secondary_routing_address:
other_account_secondary_routing_scheme:
value: 5987953
{
"counterparties":[{
"name":"CounterpartyName",
"description":"My landlord",
"currency":"EUR",
"created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"this_bank_id":"gh.29.uk",
"this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"this_view_id":"owner",
"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"other_bank_routing_scheme":"OBP",
"other_bank_routing_address":"gh.29.uk",
"other_branch_routing_scheme":"OBP",
"other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
"other_account_routing_scheme":"OBP",
"other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
"other_account_secondary_routing_scheme":"IBAN",
"other_account_secondary_routing_address":"DE89370400440532013000",
"is_beneficiary":true,
"bespoke":[{
"key":"englishName",
"value":"english Name"
}]
}]
}
- 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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-50000: Unknown Error.
Get Counterparties for any account (Explicit)
Get the Counterparties (Explicit) for any account .
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON response body fields:
counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
currency: EUR
description: Description of the object. Maximum length is 2000. It can be any characters here.
is_beneficiary: false
key: CustomerNumber
name: ACCOUNT_MANAGEMENT_FEE
other_account_routing_address:
other_account_secondary_routing_address:
other_account_secondary_routing_scheme:
value: 5987953
{
"counterparties":[{
"name":"CounterpartyName",
"description":"My landlord",
"currency":"EUR",
"created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"this_bank_id":"gh.29.uk",
"this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"this_view_id":"owner",
"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"other_bank_routing_scheme":"OBP",
"other_bank_routing_address":"gh.29.uk",
"other_branch_routing_scheme":"OBP",
"other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
"other_account_routing_scheme":"OBP",
"other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
"other_account_secondary_routing_scheme":"IBAN",
"other_account_secondary_routing_address":"DE89370400440532013000",
"is_beneficiary":true,
"bespoke":[{
"key":"englishName",
"value":"english Name"
}]
}]
}
-
CanGetCounterparties
- Please login to request this Role
-
CanGetCounterpartiesAtAnyBank
- 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-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-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Counterparty by Id for any account (Explicit)
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
COUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
VIEW_ID: owner
JSON response body fields:
counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
currency: EUR
date: 2020-01-27
description: Description of the object. Maximum length is 2000. It can be any characters here.
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_beneficiary: false
key: CustomerNumber
latitude: 38.8951
longitude: -77.0364
more_info: More information about this fee
name: ACCOUNT_MANAGEMENT_FEE
other_account_routing_address:
other_account_secondary_routing_address:
other_account_secondary_routing_scheme:
provider: ETHEREUM
url: http://www.example.com/id-docs/123/image.png
user:
username: felixsmith
value: 5987953
{
"name":"CounterpartyName",
"description":"My landlord",
"currency":"EUR",
"created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"this_bank_id":"gh.29.uk",
"this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"this_view_id":"owner",
"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"other_bank_routing_scheme":"OBP",
"other_bank_routing_address":"gh.29.uk",
"other_branch_routing_scheme":"OBP",
"other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
"other_account_routing_scheme":"OBP",
"other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
"other_account_secondary_routing_scheme":"IBAN",
"other_account_secondary_routing_address":"DE89370400440532013000",
"is_beneficiary":true,
"bespoke":[{
"key":"englishName",
"value":"english Name"
}],
"metadata":{
"public_alias":"String",
"more_info":"String",
"url":"String",
"image_url":"String",
"open_corporates_url":"String",
"corporate_location":{
"latitude":11.45,
"longitude":11.45,
"date":"1100-01-01T00:00:00Z",
"user":{
"id":"123",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
}
},
"physical_location":{
"latitude":11.45,
"longitude":11.45,
"date":"1100-01-01T00:00:00Z",
"user":{
"id":"123",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
}
},
"private_alias":"String"
}
}
-
CanGetCounterpartyAtAnyBank
- Please login to request this Role
-
CanGetCounterparty
- 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-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-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
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Counterparty by name for any account (Explicit)
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
COUNTERPARTY_NAME: John Smith Ltd.
VIEW_ID: owner
JSON response body fields:
counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
currency: EUR
date: 2020-01-27
description: Description of the object. Maximum length is 2000. It can be any characters here.
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_beneficiary: false
key: CustomerNumber
latitude: 38.8951
longitude: -77.0364
more_info: More information about this fee
name: ACCOUNT_MANAGEMENT_FEE
other_account_routing_address:
other_account_secondary_routing_address:
other_account_secondary_routing_scheme:
provider: ETHEREUM
url: http://www.example.com/id-docs/123/image.png
user:
username: felixsmith
value: 5987953
{
"name":"CounterpartyName",
"description":"My landlord",
"currency":"EUR",
"created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"this_bank_id":"gh.29.uk",
"this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"this_view_id":"owner",
"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"other_bank_routing_scheme":"OBP",
"other_bank_routing_address":"gh.29.uk",
"other_branch_routing_scheme":"OBP",
"other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
"other_account_routing_scheme":"OBP",
"other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
"other_account_secondary_routing_scheme":"IBAN",
"other_account_secondary_routing_address":"DE89370400440532013000",
"is_beneficiary":true,
"bespoke":[{
"key":"englishName",
"value":"english Name"
}],
"metadata":{
"public_alias":"String",
"more_info":"String",
"url":"String",
"image_url":"String",
"open_corporates_url":"String",
"corporate_location":{
"latitude":11.45,
"longitude":11.45,
"date":"1100-01-01T00:00:00Z",
"user":{
"id":"123",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
}
},
"physical_location":{
"latitude":11.45,
"longitude":11.45,
"date":"1100-01-01T00:00:00Z",
"user":{
"id":"123",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
}
},
"private_alias":"String"
}
}
-
CanGetCounterpartyAtAnyBank
- Please login to request this Role
-
CanGetCounterparty
- 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-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-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
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
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.
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON response body fields:
URL: http://www.example.com/id-docs/123/image.png
date: 2020-01-27
id: d8839721-ad8f-45dd-9f78-2080414b93f9
latitude: 38.8951
longitude: -77.0364
more_info: More information about this fee
name: ACCOUNT_MANAGEMENT_FEE
provider: ETHEREUM
scheme: OBP
user:
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"holder":{
"name":"OBP",
"is_alias":true
},
"bank_routing":{
"scheme":"OBP",
"address":"gh.29.uk"
},
"account_routings":[{
"scheme":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"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":"1100-01-01T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
},
"physical_location":{
"latitude":1.231,
"longitude":1.231,
"date":"1100-01-01T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}
}
}
- 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-50200: Connector cannot return the data we requested.
- 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.
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON response body fields:
URL: http://www.example.com/id-docs/123/image.png
date: 2020-01-27
id: d8839721-ad8f-45dd-9f78-2080414b93f9
latitude: 38.8951
longitude: -77.0364
more_info: More information about this fee
name: ACCOUNT_MANAGEMENT_FEE
provider: ETHEREUM
scheme: OBP
user:
{
"other_accounts":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"holder":{
"name":"OBP",
"is_alias":true
},
"bank_routing":{
"scheme":"OBP",
"address":"gh.29.uk"
},
"account_routings":[{
"scheme":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"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":"1100-01-01T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
},
"physical_location":{
"latitude":1.231,
"longitude":1.231,
"date":"1100-01-01T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}
}
}]
}
- 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
Create Customer Account Link
Link a Customer to a Account
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
bank_id: gh.29.uk
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
relationship_type: Owner
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
bank_id: gh.29.uk
customer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
relationship_type: Owner
{
"customer_account_link_id":"xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"relationship_type":"Owner"
}
-
CanCreateCustomerAccountLink
- 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-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-10001: Incorrect json format.
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-20006: User is missing one or more roles:
- OBP-30223: The Account is already linked to a Customer at the bank specified by BANK_ID
- OBP-30224: Could not create the customer account link.
- OBP-50000: Unknown Error.
Create Direct Debit
Create direct debit for an account.
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON request body fields:
counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
date_starts: 2020-01-27
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
date_expires: 2021-01-27
date_signed: 2020-01-27
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
active: false
bank_id: gh.29.uk
counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
date_cancelled: 2020-01-27
date_expires: 2021-01-27
date_signed: 2020-01-27
date_starts: 2020-01-27
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
{
"direct_debit_id":"aa0533bd-eb22-4bff-af75-d45240361b05",
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"date_signed":"2024-12-11T21:00:24Z",
"date_starts":"2024-12-11T21:00:24Z",
"date_expires":"2024-12-11T21:00:24Z",
"date_cancelled":"2024-12-11T21:00:24Z",
"active":true
}
- 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-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-10001: Incorrect json format.
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-20057: User not found by userId.
- OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.
- OBP-50000: Unknown Error.
Create Direct Debit (management)
Create direct debit for an account.
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
JSON request body fields:
counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
date_starts: 2020-01-27
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
date_expires: 2021-01-27
date_signed: 2020-01-27
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
active: false
bank_id: gh.29.uk
counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
date_cancelled: 2020-01-27
date_expires: 2021-01-27
date_signed: 2020-01-27
date_starts: 2020-01-27
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
{
"direct_debit_id":"aa0533bd-eb22-4bff-af75-d45240361b05",
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"date_signed":"2024-12-11T21:00:24Z",
"date_starts":"2024-12-11T21:00:24Z",
"date_expires":"2024-12-11T21:00:24Z",
"date_cancelled":"2024-12-11T21:00:24Z",
"active":true
}
-
CanCreateDirectDebitAtOneBank
- 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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30022: The current view does not have the permission:
- OBP-10001: Incorrect json format.
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-20057: User not found by userId.
- OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Create Standing Order
Create standing order for an account.
when -> frequency = {‘YEARLY’,’MONTHLY, ‘WEEKLY’, ‘BI-WEEKLY’, DAILY’}
when -> detail = { ‘FIRST_MONDAY’, ‘FIRST_DAY’, ‘LAST_DAY’}}
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON request body fields:
amount: 10.12
counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
date_starts: 2020-01-27
frequency: DAILY
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
when: 2020-01-27
date_expires: 2021-01-27
date_signed: 2020-01-27
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
active: false
amount: 10.12
bank_id: gh.29.uk
counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
date_cancelled: 2020-01-27
date_expires: 2021-01-27
date_signed: 2020-01-27
date_starts: 2020-01-27
frequency: DAILY
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
when: 2020-01-27
{
"standing_order_id":"aa0533bd-eb22-4bff-af75-d45240361b05",
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"amount":{
"currency":"EUR",
"amount":"0"
},
"when":{
"frequency":"WEEKLY",
"detail":"FIRST_DAY"
},
"date_signed":"2024-12-11T21:00:24Z",
"date_starts":"2024-12-11T21:00:24Z",
"date_expires":"2024-12-11T21:00:24Z",
"date_cancelled":"2024-12-11T21:00:24Z",
"active":true
}
- 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-30022: The current view does not have the permission:
- OBP-10001: Incorrect json format.
- OBP-10002: Invalid Number. Could not convert value to a number.
- OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-20057: User not found by userId.
- OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-50000: Unknown Error.
Create Standing Order (management)
Create standing order for an account.
when -> frequency = {‘YEARLY’,’MONTHLY, ‘WEEKLY’, ‘BI-WEEKLY’, DAILY’}
when -> detail = { ‘FIRST_MONDAY’, ‘FIRST_DAY’, ‘LAST_DAY’}}
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
JSON request body fields:
amount: 10.12
counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
date_starts: 2020-01-27
frequency: DAILY
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
when: 2020-01-27
date_expires: 2021-01-27
date_signed: 2020-01-27
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
active: false
amount: 10.12
bank_id: gh.29.uk
counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
currency: EUR
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
date_cancelled: 2020-01-27
date_expires: 2021-01-27
date_signed: 2020-01-27
date_starts: 2020-01-27
frequency: DAILY
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
when: 2020-01-27
{
"standing_order_id":"aa0533bd-eb22-4bff-af75-d45240361b05",
"bank_id":"gh.29.uk",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"amount":{
"currency":"EUR",
"amount":"0"
},
"when":{
"frequency":"WEEKLY",
"detail":"FIRST_DAY"
},
"date_signed":"2024-12-11T21:00:24Z",
"date_starts":"2024-12-11T21:00:24Z",
"date_expires":"2024-12-11T21:00:24Z",
"date_cancelled":"2024-12-11T21:00:24Z",
"active":true
}
-
CanCreateStandingOrderAtOneBank
- Please login to request this Role