OBP
v4.0.0
filtered by tag: Account, Card (55 APIs)
Bank
Select Bank Abanca (at.03.2080.uk) Abanca (at02-2080--01) Abanca (at03-2080) BBVA (at.03.0182.es) BBVA (at02-0182--01) BBVA (at03-0182) BMN (at.03.0487.es) BMN (at02-0487--01) BMN (at03-0487) BOP (Bank-of-Pune) Banca March (at.03.0061.es) Banca March (at02-0061--01) Banca March (at03-0061) Banco Pastor (at.03.0238.es) Banco Pastor (at02-0238--01) Banco Pastor (at03-0238) Banco Popular (at.03.0075.es) Banco Popular (at02-0075--01) Banco Popular (at03-0075) Banco Santander (at.03.0049.es) Banco Santander (at02-0049--01) Banco Santander (at03-0049) Bank New (Bank 85SP7Q) Bank X (at.03.bank-x.uk) Bank X (at02-bank-x--01) Bank X (at03-bank-x) Bank X (obp-bank-x-g) Bank X (obp-bank-x-r) Bank X (obp-bankx-m) Bank X (obp-bankx-n) Bank X (obp-bankx-q) Bank Y (at.03.bank-y.uk) Bank Y (at02-bank-y--01) Bank Y (at03-bank-y) Bank Y (obp-bank-y-g) Bank Y (obp-bank-y-r) Bank Y (obp-banky-m) Bank Y (obp-banky-n) Bank Y (obp-banky-q) Bank of Berlin (bb.01.de) Bankia (at.03.2038.es) Bankia (at02-2038--01) Bankia (at03-2038) Bankinter (at.03.0128.es) Bankinter (at02-0128--01) Bankinter (at03-0128) CaixaBank (at.03.2100.es) CaixaBank (at02-2100--01) CaixaBank (at03-2100) Cetelem (at.03.0225.es) Cetelem (at02-0225--01) Cetelem (at03-0225) Deutche Bank Test (deutche-test) Deutsche Bank (at.03.0019.es) Deutsche Bank (at02-0019--01) Deutsche Bank (at03-0019) Erste Bank Test (erste-test) FR (gh.29.fr) FR (op.01.fr) FR (op.02.fr) HSBC Test (hsbc-test) ING (at.03.1465.es) ING (at02-1465--01) ING (at03-1465) Ibercaja (at.03.2085.es) Ibercaja (at02-2085--01) Ibercaja (at03-2085) Import Bank 0 (importbank0) Import Bank 1 (importbank1) India Bank X (in-bank-x-1) India Bank X (in-bank-x-2) India Bank Y (in-bank-y-1) India Bank Y (in-bank-y-2) Kutxabank (at.03.2095.es) Kutxabank (at02-2095--01) Kutxabank (at03-2095) LA BANQUE POSTALE (gh.42.fr.lbp) Liberbank (at.03.2048.es) Liberbank (at02-2048--01) Liberbank (at03-2048) Nordea (nordea) Nordea (nordeaab) Open Bank (at.03.0073.es) Open Bank (at02-0073--01) Open Bank (at03-0073) Pune (Bank of Pune) Sabadell (at.03.0081.es) Sabadell (at02-0081--01) Sabadell (at03-0081) TB (test-bank) TB (testowy_bank_id) The Royal Bank of Scotland (rbs) Tr (gh.29.tr) Tr (op.01.tr) Tr (op.02.tr) US (gh.29.us) US (op.01.us) US (op.02.us) Unicaja (at.03.2103.es) Unicaja (at02-2103--01) Unicaja (at03-2103) aum (au.01.aum.aum) aus (au.01.aus.aus) be (gh.29.be) be (op.01.be) be (op.02.be) cb (chase) de (gh.29.de) de (op.01.de) de (op.02.de) fcb (fcb) fi (gh.29.fi) fi (op.01.fi) fi (op.02.fi) inv (inv.01.us.inv) it (gh.29.it) it (op.01.it) it (op.02.it) rxw (rxw) uk (au.01.uk.uk) uk (gh.29.uk) uk (gh.29.uk.x) uk (gh.42.uk.uk) uk (inv.01.uk.uk) uk (op.01.uk) uk (op.02.uk) uk (somo.55.uk.uk)
Accounts
Select Account
Views
Login for Views
Counterparties
Login for CPs
Transactions
Login for Trans
Check Available Funds
Check Available Funds
Mandatory URL parameters:
amount=NUMBER
currency=STRING
I will become the full path
Typical Successful Response:
{
"answer":"yes",
"date":"2019-12-05T12:47:19Z",
"available_funds_request_id":"c4ykz59svsr9b7fmdxk8ezs7"
}
Possible Errors:
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.
Implemented in OBPv3.1.0 by checkFundsAvailable
Create Account
Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.
The User can create an Account for themself - or - the User that has the USER_ID specified in the POST body.
If the PUT body USER_ID is specified, the logged in user must have the Role canCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.
If the PUT body USER_ID is not specified, the account will be owned by the logged in User.
The 'type' field SHOULD be a product_code from Product.
If the type matches a product_code from Product, account attributes will be created that match the Product Attributes.
Note: The Amount MUST be zero.
I will become the full path
Typical Successful Response:
{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"label":"My Account",
"type":"AC",
"balance":{
"currency":"EUR",
"amount":"10"
},
"branch_id":"DERBY6",
"account_routing":{
"scheme":"AccountNumber",
"address":"4930396"
},
"account_attributes":[{
"product_code":"saving1",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23"
}]
}
Required Roles:
CanCreateAccount
- Please login to request this Role
Possible Errors:
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.
Implemented in OBPv3.1.0 by createAccount
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
I will become the full path
Typical Successful Response:
{
"product_code":"saving1",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23"
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-10001: Incorrect json format. OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by createAccountAttribute
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
Account Attributes - A list that might include custom defined account attribute
Tags - A list of Tags assigned to this account
This call returns the owner view and requires access to that view.
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"bank_id":"GENODEM1GLS",
"label":"My Account",
"number":"546387432",
"owners":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}],
"product_code":"AC",
"balance":{
"currency":"EUR",
"amount":"10"
},
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"views_basic":[{
"id":"owner",
"short_name":"Owner",
"description":"This view is for the owner for the account.",
"is_public":false
}],
"account_attributes":[{
"product_code":"saving1",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23"
}],
"tags":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}]
}
Possible Errors:
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. OBP-50000: Unknown Error.
Implemented in OBPv4.0.0 by getCoreAccountById
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
.
I will become the full path
Typical Successful Response:
{
"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":"OBP",
"balance":{
"currency":"EUR",
"amount":"10"
},
"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":"GENODEM1GLS",
"account_routing":{
"scheme":"AccountNumber",
"address":"4930396"
},
"account_attributes":[{
"product_code":"saving1",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23"
}],
"tags":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}]
}
Possible Errors:
OBP-30001: Bank not found. Please specify a valid value for BANK_ID. OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID. OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID. OBP-50000: Unknown Error.
Implemented in OBPv4.0.0 by getPrivateAccountByIdFull
Get Accounts Balances
Get the Balances for the Accounts of the current User at one bank.
I will become the full path
Typical Successful Response:
{
"accounts":[{
"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"label":"My Account",
"bank_id":"GENODEM1GLS",
"account_routings":[{
"scheme":"accountNumber",
"address":"123456"
}],
"balance":{
"currency":"EUR",
"amount":"100"
}
}],
"overall_balance":{
"currency":"EUR",
"amount":"100"
},
"overall_balance_date":"2017-09-19T00:00:00Z"
}
Possible Errors:
OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getBankAccountsBalances
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
I will become the full path
Typical Successful Response:
{
"accounts":[{
"id":"12314",
"bank_id":"123",
"number":"123",
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}]
}]
}
Possible Errors:
OBP-50000: Unknown Error.
Implemented in OBPv3.0.0 by getAccountsHeld
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
I will become the full path
Typical Successful Response:
{
"accounts":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf"
}]
}
Possible Errors:
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.
Implemented in OBPv3.0.0 by getPrivateAccountIdsbyBankId
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
I will become the full path
Typical Successful Response:
{
"accounts":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"String",
"bank_id":"GENODEM1GLS",
"account_type":"330",
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"views":[{
"id":"owner",
"short_name":"Owner",
"description":"This view is for the owner for the account.",
"is_public":false
}]
}]
}
Possible Errors:
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.
Implemented in OBPv3.0.0 by privateAccountsAtOneBank
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:
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_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"accounts":[{
"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"label":"NoneLabel",
"bank_id":"GENODEM1GLS",
"views_available":[{
"id":"1",
"short_name":"HHH",
"is_public":true
}]
}]
}
Possible Errors:
OBP-30001: Bank not found. Please specify a valid value for BANK_ID. OBP-50000: Unknown Error.
Implemented in OBPv2.0.0 by getPrivateAccountsAtOneBank
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
I will become the full path
Typical Successful Response:
{
"accounts":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"String",
"bank_id":"GENODEM1GLS",
"account_type":"330",
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"views":[{
"id":"owner",
"short_name":"Owner",
"description":"This view is for the owner for the account.",
"is_public":false
}]
}]
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-50000: Unknown Error.
Implemented in OBPv3.0.0 by corePrivateAccountsAllBanks
Get Checkbook orders
NOTE: This endpoint currently only returns example data.
Get all checkbook orders
I will become the full path
Typical Successful Response:
{
"account":{
"bank_id":"GENODEM1GLS",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"account_type":"330",
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"branch_routings":[{
"scheme":"BranchNumber",
"address":"678"
}]
},
"orders":[{
"order":{
"order_id":"xjksajfkj",
"order_date":"07082013",
"number_of_checkbooks":"4",
"distribution_channel":"1201",
"status":"2",
"first_check_number":"5165276",
"shipping_code":"1"
}
}]
}
Possible Errors:
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.
Implemented in OBPv3.1.0 by getCheckbookOrders
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'
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"accounts":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"bank_id":"String",
"label":"String",
"number":"String",
"owners":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}],
"type":"String",
"balance":{
"currency":"EUR",
"amount":"10"
},
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"account_rules":[{
"scheme":"OVERDRAFT",
"value":"10"
}]
}]
}
Required Roles:
CanUseFirehoseAtAnyBank
- Please login to request this Role
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-50000: Unknown Error.
Implemented in OBPv3.0.0 by getFirehoseAccountsAtOneBank
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
I will become the full path
Typical Successful Response:
{
"product_code":"saving1",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23"
}
Required Roles:
CanUpdateAccountAttribute
- Please login to request this Role
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-10001: Incorrect json format. OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by updateAccountAttribute
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
I will become the full path
Typical Successful Response:
{
"success":"Success"
}
Possible Errors:
OBP-10001: Incorrect json format. OBP-20001: User not logged in. Authentication is required! OBP-50000: Unknown Error. OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. user does not have access to owner view on account
Implemented in OBPv1.2.1 by updateAccountLabel
Update Account.
Update the account.
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"bank_id":"GENODEM1GLS",
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"label":"Label",
"type":"CURRENT",
"branch_id":"1234",
"account_routing":{
"scheme":"AccountNumber",
"address":"4930396"
}
}
Required Roles:
CanUpdateAccount
- Please login to request this Role
Possible Errors:
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.
Implemented in OBPv3.1.0 by updateAccount
Create Account Application
Create Account Application
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
"product_code":"saveing1",
"user":{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email":"eveline@example.com",
"provider_id":"Chris",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
},
"customer":{
"bank_id":"GENODEM1GLS",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"customer_number":"5987953",
"legal_name":"Eveline Tripman",
"mobile_phone_number":"+44 07972 444 876",
"email":"eveline@example.com",
"face_image":{
"url":"www.openbankproject",
"date":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":10,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"10"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branchId":"DERBY6",
"nameSuffix":"Sr"
},
"date_of_application":"2017-09-19T00:00:00Z",
"status":"REQUESTED"
}
Possible Errors:
OBP-10001: Incorrect json format. OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by createAccountApplication
Get Account Application by Id
Get the Account Application.
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
"product_code":"saveing1",
"user":{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email":"eveline@example.com",
"provider_id":"Chris",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
},
"customer":{
"bank_id":"GENODEM1GLS",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"customer_number":"5987953",
"legal_name":"Eveline Tripman",
"mobile_phone_number":"+44 07972 444 876",
"email":"eveline@example.com",
"face_image":{
"url":"www.openbankproject",
"date":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":10,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"10"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branchId":"DERBY6",
"nameSuffix":"Sr"
},
"date_of_application":"2017-09-19T00:00:00Z",
"status":"REQUESTED"
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-20006: User is missing one or more roles: OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getAccountApplication
Get Account Applications
Get the Account Applications.
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"account_applications":[{
"account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
"product_code":"saveing1",
"user":{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email":"eveline@example.com",
"provider_id":"Chris",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
},
"customer":{
"bank_id":"GENODEM1GLS",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"customer_number":"5987953",
"legal_name":"Eveline Tripman",
"mobile_phone_number":"+44 07972 444 876",
"email":"eveline@example.com",
"face_image":{
"url":"www.openbankproject",
"date":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":10,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"10"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branchId":"DERBY6",
"nameSuffix":"Sr"
},
"date_of_application":"2017-09-19T00:00:00Z",
"status":"REQUESTED"
}]
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-20006: User is missing one or more roles: OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getAccountApplications
Update Account Application Status
Update an Account Application status
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
"product_code":"saveing1",
"user":{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email":"eveline@example.com",
"provider_id":"Chris",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
},
"customer":{
"bank_id":"GENODEM1GLS",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"customer_number":"5987953",
"legal_name":"Eveline Tripman",
"mobile_phone_number":"+44 07972 444 876",
"email":"eveline@example.com",
"face_image":{
"url":"www.openbankproject",
"date":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":10,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"10"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branchId":"DERBY6",
"nameSuffix":"Sr"
},
"date_of_application":"2017-09-19T00:00:00Z",
"status":"REQUESTED"
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-20006: User is missing one or more roles: OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by updateAccountApplicationStatus
Add 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.
I will become the full path
Typical Successful Response:
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. OBP-10001: Incorrect json format. OBP-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-50000: Unknown Error.
Implemented in OBPv4.0.0 by addTagForViewOnAccount
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.
I will become the full path
Typical Successful Response:
{
"jsonString":"{}"
}
Possible Errors:
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-50000: Unknown Error.
Implemented in OBPv4.0.0 by deleteTagForViewOnAccount
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.
I will become the full path
Typical Successful Response:
{
"tags":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}]
}
Possible Errors:
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-30005: View not found for Account. Please specify a valid value for VIEW_ID OBP-50000: Unknown Error.
Implemented in OBPv4.0.0 by getTagsForViewOnAccount
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
I will become the full path
Typical Successful Response:
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"bank_id":"String",
"label":"String",
"number":"String",
"owners":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}],
"type":"String",
"balance":{
"currency":"EUR",
"amount":"10"
},
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"account_rules":[{
"scheme":"OVERDRAFT",
"value":"10"
}]
}
Possible Errors:
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.
Implemented in OBPv3.0.0 by getPublicAccountById
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
I will become the full path
Typical Successful Response:
{
"accounts":[{
"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"label":"NoneLabel",
"bank_id":"GENODEM1GLS",
"views_available":[{
"id":"1",
"short_name":"HHH",
"is_public":true
}]
}]
}
Possible Errors:
OBP-50000: Unknown Error.
Implemented in OBPv2.0.0 by publicAccountsAtOneBank
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
I will become the full path
Typical Successful Response:
{
"accounts":[{
"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"label":"NoneLabel",
"bank_id":"GENODEM1GLS",
"views_available":[{
"id":"1",
"short_name":"HHH",
"is_public":true
}]
}]
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! Could not get accounts. OBP-50000: Unknown Error.
Implemented in OBPv2.0.0 by publicAccountsAllBanks
Create Card
Create Card at bank specified by BANK_ID .
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
"bank_id":"GENODEM1GLS",
"card_number":"364435172576215",
"card_type":"Credit",
"name_on_card":"SusanSmith",
"issue_number":"1",
"serial_number":"1324234",
"valid_from_date":"2017-09-19T00:00:00Z",
"expires_date":"2017-09-19T00:00:00Z",
"enabled":true,
"cancelled":true,
"on_hot_list":true,
"technology":"technologyString1",
"networks":["networks1"],
"allows":["credit","debit"],
"account":{
"id":"123",
"label":"OBP",
"views_available":[{
"id":"123",
"short_name":"short_name",
"description":"description",
"is_public":true,
"alias":"None",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_see_bank_account_bank_name":true,
"can_see_bank_account_currency":true,
"can_see_bank_account_iban":true,
"can_see_bank_account_label":true,
"can_see_bank_account_national_identifier":true,
"can_see_bank_account_number":true,
"can_see_bank_account_owners":true,
"can_see_bank_account_swift_bic":true,
"can_see_bank_account_type":true,
"can_see_comments":true,
"can_see_corporate_location":true,
"can_see_image_url":true,
"can_see_images":true,
"can_see_more_info":true,
"can_see_open_corporates_url":true,
"can_see_other_account_bank_name":true,
"can_see_other_account_iban":true,
"can_see_other_account_kind":true,
"can_see_other_account_metadata":true,
"can_see_other_account_national_identifier":true,
"can_see_other_account_number":true,
"can_see_other_account_swift_bic":true,
"can_see_owner_comment":true,
"can_see_physical_location":true,
"can_see_private_alias":true,
"can_see_public_alias":true,
"can_see_tags":true,
"can_see_transaction_amount":true,
"can_see_transaction_balance":true,
"can_see_transaction_currency":true,
"can_see_transaction_description":true,
"can_see_transaction_finish_date":true,
"can_see_transaction_metadata":true,
"can_see_transaction_other_bank_account":true,
"can_see_transaction_start_date":true,
"can_see_transaction_this_bank_account":true,
"can_see_transaction_type":true,
"can_see_url":true,
"can_see_where_tag":true
}],
"bank_id":"GENODEM1GLS"
},
"replacement":{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"RENEW"
},
"pin_reset":[{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"FORGOT"
}],
"collected":"2017-09-19T00:00:00Z",
"posted":"2017-09-19T00:00:00Z",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
Required Roles:
CanCreateCardsForBank
- Please login to request this Role
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-20006: User is missing one or more roles: OBP-10015: Allowed values are: OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by addCardForBank
Create Card Attribute
Create Card Attribute
Card Attributes are used to describe a financial Product with a list of typed key value pairs.
Each Card Attribute is linked to its Card by CARD_ID
The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"name":"OVERDRAFT_START_DATE",
"card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
"attribute_type":"DOUBLE",
"bank_id":{
"value":"GENODEM1GLS"
},
"value":"2012-04-23",
"card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-10001: Incorrect json format. OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by createCardAttribute
Delete Card
Delete a Card at bank specified by CARD_ID .
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"jsonString":"{}"
}
Required Roles:
CanCreateCardsForBank
- Please login to request this Role
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-20006: User is missing one or more roles: OBP-10015: Allowed values are: OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by deleteCardForBank
Get Card By Id
This will the datails of the card.
It shows the account infomation which linked the the card.
Also shows the card attributes of the card.
I will become the full path
Typical Successful Response:
{
"card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
"bank_id":"GENODEM1GLS",
"card_number":"364435172576215",
"card_type":"Credit",
"name_on_card":"SusanSmith",
"issue_number":"1",
"serial_number":"1324234",
"valid_from_date":"2017-09-19T00:00:00Z",
"expires_date":"2017-09-19T00:00:00Z",
"enabled":true,
"cancelled":true,
"on_hot_list":true,
"technology":"technologyString1",
"networks":["networks1"],
"allows":["credit","debit"],
"account":{
"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"label":"My Account",
"views_available":[{
"id":"owner",
"name":"Owner",
"description":"This view is for the owner for the account."
}],
"bank_id":"GENODEM1GLS"
},
"replacement":{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"RENEW"
},
"pin_reset":[{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"FORGOT"
}],
"collected":"2017-09-19T00:00:00Z",
"posted":"2017-09-19T00:00:00Z",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"card_attributes":[{
"name":"OVERDRAFT_START_DATE",
"card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
"attribute_type":"STRING",
"bank_id":{
"value":"GENODEM1GLS"
},
"value":"2012-04-23",
"card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}]
}
Possible Errors:
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.
Implemented in OBPv3.1.0 by getCardForBank
Get Cards for the specified bank
Should be able to filter on the following fields
eg:/management/banks/BANK_ID/cards?customer_id=66214b8e-259e-44ad-8868-3eb47be70646$account_id=8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0
1 customer_id should be valid customer_id, otherwise, it will return an empty card list.
2 account_id should be valid account_id , otherwise, it will return an empty card list.
${authenticationRequiredMessage(true)}
I will become the full path
Typical Successful Response:
{
"cards":[{
"card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
"bank_id":"GENODEM1GLS",
"card_number":"364435172576215",
"card_type":"Credit",
"name_on_card":"SusanSmith",
"issue_number":"1",
"serial_number":"1324234",
"valid_from_date":"2017-09-19T00:00:00Z",
"expires_date":"2017-09-19T00:00:00Z",
"enabled":true,
"cancelled":true,
"on_hot_list":true,
"technology":"technologyString1",
"networks":["networks1"],
"allows":["credit","debit"],
"account":{
"id":"123",
"label":"OBP",
"views_available":[{
"id":"123",
"short_name":"short_name",
"description":"description",
"is_public":true,
"alias":"None",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_see_bank_account_bank_name":true,
"can_see_bank_account_currency":true,
"can_see_bank_account_iban":true,
"can_see_bank_account_label":true,
"can_see_bank_account_national_identifier":true,
"can_see_bank_account_number":true,
"can_see_bank_account_owners":true,
"can_see_bank_account_swift_bic":true,
"can_see_bank_account_type":true,
"can_see_comments":true,
"can_see_corporate_location":true,
"can_see_image_url":true,
"can_see_images":true,
"can_see_more_info":true,
"can_see_open_corporates_url":true,
"can_see_other_account_bank_name":true,
"can_see_other_account_iban":true,
"can_see_other_account_kind":true,
"can_see_other_account_metadata":true,
"can_see_other_account_national_identifier":true,
"can_see_other_account_number":true,
"can_see_other_account_swift_bic":true,
"can_see_owner_comment":true,
"can_see_physical_location":true,
"can_see_private_alias":true,
"can_see_public_alias":true,
"can_see_tags":true,
"can_see_transaction_amount":true,
"can_see_transaction_balance":true,
"can_see_transaction_currency":true,
"can_see_transaction_description":true,
"can_see_transaction_finish_date":true,
"can_see_transaction_metadata":true,
"can_see_transaction_other_bank_account":true,
"can_see_transaction_start_date":true,
"can_see_transaction_this_bank_account":true,
"can_see_transaction_type":true,
"can_see_url":true,
"can_see_where_tag":true
}],
"bank_id":"GENODEM1GLS"
},
"replacement":{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"RENEW"
},
"pin_reset":[{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"FORGOT"
}],
"collected":"2017-09-19T00:00:00Z",
"posted":"2017-09-19T00:00:00Z",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}]
}
Possible Errors:
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.
Implemented in OBPv3.1.0 by getCardsForBank
Get cards for the current user
Returns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc.
I will become the full path
Typical Successful Response:
{
"cards":[{
"bank_id":"GENODEM1GLS",
"bank_card_number":"364435172576215",
"name_on_card":"String",
"issue_number":"1",
"serial_number":"1324234",
"valid_from_date":"2017-09-19T00:00:00Z",
"expires_date":"2017-09-19T00:00:00Z",
"enabled":true,
"cancelled":true,
"on_hot_list":true,
"technology":"String",
"networks":["String"],
"allows":["String"],
"account":{
"id":"123",
"label":"OBP",
"views_available":[{
"id":"123",
"short_name":"short_name",
"description":"description",
"is_public":true,
"alias":"None",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_see_bank_account_bank_name":true,
"can_see_bank_account_currency":true,
"can_see_bank_account_iban":true,
"can_see_bank_account_label":true,
"can_see_bank_account_national_identifier":true,
"can_see_bank_account_number":true,
"can_see_bank_account_owners":true,
"can_see_bank_account_swift_bic":true,
"can_see_bank_account_type":true,
"can_see_comments":true,
"can_see_corporate_location":true,
"can_see_image_url":true,
"can_see_images":true,
"can_see_more_info":true,
"can_see_open_corporates_url":true,
"can_see_other_account_bank_name":true,
"can_see_other_account_iban":true,
"can_see_other_account_kind":true,
"can_see_other_account_metadata":true,
"can_see_other_account_national_identifier":true,
"can_see_other_account_number":true,
"can_see_other_account_swift_bic":true,
"can_see_owner_comment":true,
"can_see_physical_location":true,
"can_see_private_alias":true,
"can_see_public_alias":true,
"can_see_tags":true,
"can_see_transaction_amount":true,
"can_see_transaction_balance":true,
"can_see_transaction_currency":true,
"can_see_transaction_description":true,
"can_see_transaction_finish_date":true,
"can_see_transaction_metadata":true,
"can_see_transaction_other_bank_account":true,
"can_see_transaction_start_date":true,
"can_see_transaction_this_bank_account":true,
"can_see_transaction_type":true,
"can_see_url":true,
"can_see_where_tag":true
}],
"bank_id":"GENODEM1GLS"
},
"replacement":{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"RENEW"
},
"pin_reset":[{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"FORGOT"
}],
"collected":"2017-09-19T00:00:00Z",
"posted":"2017-09-19T00:00:00Z"
}]
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-50000: Unknown Error.
Implemented in OBPv1.3.0 by getCards
Get status of Credit Card order
NOTE: This endpoint currently only returns example data.
Get status of Credit Card orders
Get all orders
I will become the full path
Typical Successful Response:
{
"cards":[{
"card_type":"5",
"card_description":"good",
"use_type":"3"
}]
}
Possible Errors:
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-50212: Connector did not return the set of status of credit card. OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getStatusOfCreditCardOrder
Update Card
Update Card at bank specified by CARD_ID .
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
"bank_id":"GENODEM1GLS",
"card_number":"364435172576215",
"card_type":"Credit",
"name_on_card":"SusanSmith",
"issue_number":"1",
"serial_number":"1324234",
"valid_from_date":"2017-09-19T00:00:00Z",
"expires_date":"2017-09-19T00:00:00Z",
"enabled":true,
"cancelled":true,
"on_hot_list":true,
"technology":"technologyString1",
"networks":["networks1"],
"allows":["credit","debit"],
"account":{
"id":"123",
"label":"OBP",
"views_available":[{
"id":"123",
"short_name":"short_name",
"description":"description",
"is_public":true,
"alias":"None",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_see_bank_account_bank_name":true,
"can_see_bank_account_currency":true,
"can_see_bank_account_iban":true,
"can_see_bank_account_label":true,
"can_see_bank_account_national_identifier":true,
"can_see_bank_account_number":true,
"can_see_bank_account_owners":true,
"can_see_bank_account_swift_bic":true,
"can_see_bank_account_type":true,
"can_see_comments":true,
"can_see_corporate_location":true,
"can_see_image_url":true,
"can_see_images":true,
"can_see_more_info":true,
"can_see_open_corporates_url":true,
"can_see_other_account_bank_name":true,
"can_see_other_account_iban":true,
"can_see_other_account_kind":true,
"can_see_other_account_metadata":true,
"can_see_other_account_national_identifier":true,
"can_see_other_account_number":true,
"can_see_other_account_swift_bic":true,
"can_see_owner_comment":true,
"can_see_physical_location":true,
"can_see_private_alias":true,
"can_see_public_alias":true,
"can_see_tags":true,
"can_see_transaction_amount":true,
"can_see_transaction_balance":true,
"can_see_transaction_currency":true,
"can_see_transaction_description":true,
"can_see_transaction_finish_date":true,
"can_see_transaction_metadata":true,
"can_see_transaction_other_bank_account":true,
"can_see_transaction_start_date":true,
"can_see_transaction_this_bank_account":true,
"can_see_transaction_type":true,
"can_see_url":true,
"can_see_where_tag":true
}],
"bank_id":"GENODEM1GLS"
},
"replacement":{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"RENEW"
},
"pin_reset":[{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"FORGOT"
}],
"collected":"2017-09-19T00:00:00Z",
"posted":"2017-09-19T00:00:00Z",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
Required Roles:
CanCreateCardsForBank
- Please login to request this Role
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-20006: User is missing one or more roles: OBP-10015: Allowed values are: OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by updatedCardForBank
Update Card Attribute
Update Card Attribute
Card Attributes are used to describe a financial Product with a list of typed key value pairs.
Each Card Attribute is linked to its Card by CARD_ID
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"name":"OVERDRAFT_START_DATE",
"card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
"attribute_type":"DOUBLE",
"bank_id":{
"value":"GENODEM1GLS"
},
"value":"2012-04-23",
"card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-10001: Incorrect json format. OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by updateCardAttribute
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)
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 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 support list of key-value, you can add it to the counterarty.
bespoke.key : any info-key you want to add to this counerparty
bespoke.value : any info-value you want to add to this counerparty
The view specified by VIEW_ID must have the canAddCounterparty permission
A minimal example for TransactionRequestType == COUNTERPARTY
{
"name": "Tesobe1",
"description": "Good Company",
"other_bank_routing_scheme": "bankId",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "accountId",
"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",
"other_bank_routing_scheme": "bankId",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "accountId",
"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
I will become the full path
Typical Successful Response:
{
"name":"CounterpartyName",
"description":"My landlord",
"created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"this_bank_id":"GENODEM1GLS",
"this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"this_view_id":"owner",
"counterparty_id":"1d65db7c-a7b2-4839-af41-958276ab7790",
"other_bank_routing_scheme":"bankCode",
"other_bank_routing_address":"10",
"other_branch_routing_scheme":"branchNumber",
"other_branch_routing_address":"10010",
"other_account_routing_scheme":"accountNumber",
"other_account_routing_address":"7987987-2348987-234234",
"other_account_secondary_routing_scheme":"accountId",
"other_account_secondary_routing_address":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"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":"2017-09-19T00:00:00Z",
"user":{
"id":"123",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
}
},
"physical_location":{
"latitude":11.45,
"longitude":11.45,
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"123",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
}
},
"private_alias":"String"
}
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255. OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255. OBP-30001: Bank not found. Please specify a valid value for BANK_ID. OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID. OBP-10001: Incorrect json format. OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME. OBP-50000: Unknown Error.
Implemented in OBPv2.2.0 by createCounterparty
Get Counterparties (Explicit).
Get the Counterparties (Explicit) for the account / view.
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"counterparties":[{
"name":"CounterpartyName",
"description":"My landlord",
"created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"this_bank_id":"GENODEM1GLS",
"this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"this_view_id":"owner",
"counterparty_id":"1d65db7c-a7b2-4839-af41-958276ab7790",
"other_bank_routing_scheme":"bankCode",
"other_bank_routing_address":"10",
"other_branch_routing_scheme":"branchNumber",
"other_branch_routing_address":"10010",
"other_account_routing_scheme":"accountNumber",
"other_account_routing_address":"7987987-2348987-234234",
"other_account_secondary_routing_scheme":"accountId",
"other_account_secondary_routing_address":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"is_beneficiary":true,
"bespoke":[{
"key":"englishName",
"value":"english Name"
}]
}]
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID OBP-30022: The current view does not have the permission: OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID. OBP-50000: Unknown Error.
Implemented in OBPv2.2.0 by getExplictCounterpartiesForAccount
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.
I will become the full path
Typical Successful Response:
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"holder":{
"name":"OBP",
"is_alias":true
},
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
},
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"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":"2017-09-19T00: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":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}
}
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID OBP-50200: Connector cannot return the data we requested. OBP-50000: Unknown Error.
Implemented in OBPv3.0.0 by getOtherAccountByIdForBankAccount
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.
I will become the full path
Typical Successful Response:
{
"other_accounts":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"holder":{
"name":"OBP",
"is_alias":true
},
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
},
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"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":"2017-09-19T00: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":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}
}
}]
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID OBP-50200: Connector cannot return the data we requested. OBP-50000: Unknown Error.
Implemented in OBPv3.0.0 by getOtherAccountsForBankAccount
Create Direct Debit
Create direct debit for an account.
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"direct_debit_id":"aa0533bd-eb22-4bff-af75-d45240361b05",
"bank_id":"GENODEM1GLS",
"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":"2019-12-05T12:47:19Z",
"date_starts":"2019-12-05T12:47:19Z",
"date_expires":"2019-12-05T12:47:19Z",
"date_cancelled":"2019-12-05T12:47:19Z",
"active":true
}
Possible Errors:
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.
Implemented in OBPv4.0.0 by createDirectDebit
Create Direct Debit(management)
Create direct debit for an account.
Authentication is Mandatory
I will become the full path
Typical Successful Response:
{
"direct_debit_id":"aa0533bd-eb22-4bff-af75-d45240361b05",
"bank_id":"GENODEM1GLS",
"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":"2019-12-05T12:47:19Z",
"date_starts":"2019-12-05T12:47:19Z",
"date_expires":"2019-12-05T12:47:19Z",
"date_cancelled":"2019-12-05T12:47:19Z",
"active":true
}
Possible Errors:
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.
Implemented in OBPv4.0.0 by createDirectDebitManagement
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
I will become the full path
Typical Successful Response:
{
"standing_order_id":"aa0533bd-eb22-4bff-af75-d45240361b05",
"bank_id":"GENODEM1GLS",
"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":"10"
},
"date_signed":"2019-12-05T12:47:19Z",
"date_starts":"2019-12-05T12:47:19Z",
"date_expires":"2019-12-05T12:47:19Z",
"date_cancelled":"2019-12-05T12:47:19Z",
"active":true
}
Possible Errors:
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-50000: Unknown Error.
Implemented in OBPv4.0.0 by createStandingOrder
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
I will become the full path
Typical Successful Response:
{
"standing_order_id":"aa0533bd-eb22-4bff-af75-d45240361b05",
"bank_id":"GENODEM1GLS",
"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":"10"
},
"date_signed":"2019-12-05T12:47:19Z",
"date_starts":"2019-12-05T12:47:19Z",
"date_expires":"2019-12-05T12:47:19Z",
"date_cancelled":"2019-12-05T12:47:19Z",
"active":true
}
Possible Errors:
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-50000: Unknown Error.
Implemented in OBPv4.0.0 by createStandingOrderManagement
Get Transactions for Account (Core)
Returns transactions list (Core info) of the account specified by ACCOUNT_ID.
Authentication is Mandatory
Possible custom headers for pagination:
sort_direction=ASC/DESC ==> default value: DESC. The sort field is the completed date.
limit=NUMBER ==> default value: 50
offset=NUMBER ==> default value: 0
from_date=DATE => default value: 0000-00-00T00:00:00.000Z
to_date=DATE => default value: 3049-01-01T00:00:00.000Z
Date format parameter : yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.
I will become the full path
Typical Successful Response:
{
"transactions":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"this_account":{
"id":"String",
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
},
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"holders":[{
"name":"OBP",
"is_alias":true
}]
},
"other_account":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"holder":{
"name":"OBP",
"is_alias":true
},
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
},
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}]
},
"details":{
"type":"AC",
"description":"OBP",
"posted":"2017-09-19T00:00:00Z",
"completed":"2017-09-19T00:00:00Z",
"new_balance":{
"currency":"EUR",
"amount":"10"
},
"value":{
"currency":"EUR",
"amount":"10"
}
}
}]
}
Possible Errors:
OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC! OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)! OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)! OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'! OBP-20001: User not logged in. Authentication is required! OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID OBP-50000: Unknown Error.
Implemented in OBPv3.0.0 by getCoreTransactionsForBankAccount
Get Transactions for Account (Full)
Returns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID).
Authentication is Optional
Authentication is required if the view is not public.
Possible custom headers for pagination:
sort_direction=ASC/DESC ==> default value: DESC. The sort field is the completed date.
limit=NUMBER ==> default value: 50
offset=NUMBER ==> default value: 0
from_date=DATE => default value: 0000-00-00T00:00:00.000Z
to_date=DATE => default value: 3049-01-01T00:00:00.000Z
Date format parameter : yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.
I will become the full path
Typical Successful Response:
{
"transactions":[{
"id":"String",
"this_account":{
"id":"String",
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
},
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"holders":[{
"name":"OBP",
"is_alias":true
}]
},
"other_account":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"holder":{
"name":"OBP",
"is_alias":true
},
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
},
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"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":"2017-09-19T00: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":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}
}
},
"details":{
"type":"AC",
"description":"this is for family",
"posted":"2017-09-19T00:00:00Z",
"completed":"2017-09-19T00:00:00Z",
"new_balance":{
"currency":"EUR",
"amount":"10"
},
"value":{
"currency":"EUR",
"amount":"10"
}
},
"metadata":{
"narrative":"NONE",
"comments":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}],
"tags":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}],
"images":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"NONE",
"URL":"www.openbankproject.com",
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}],
"where":{
"latitude":1.231,
"longitude":1.231,
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}
}
}]
}
Possible Errors:
OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC! OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)! OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)! OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'! OBP-20001: User not logged in. Authentication is required! OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID OBP-50000: Unknown Error.
Implemented in OBPv3.0.0 by getTransactionsForBankAccount
Create View.
Create a view on bank account
Authentication is Mandatory and the user needs to have access to the owner view.
The 'alias' field in the JSON can take one of three values:
The 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to true
and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.
The 'allowed_actions' field is a list containing the name of the actions allowed on this view, all the actions contained will be set to true
on the view creation, the rest will be set to false
.
You MUST use a leading _ (underscore) in the view name because other view names are reserved for OBP system views.
I will become the full path
Typical Successful Response:
{
"id":"1234",
"short_name":"short_name",
"description":"description",
"metadata_view":"owner",
"is_public":true,
"alias":"No",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_add_counterparty":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_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
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-10001: Incorrect json format. OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. OBP-50000: Unknown Error.
Implemented in OBPv3.0.0 by createViewForBankAccount
Delete View
Deletes the view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID.
I will become the full path
Typical Successful Response:
{
"jsonString":"{}"
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. OBP-50000: Unknown Error. user does not have owner access
Implemented in OBPv1.2.1 by deleteViewForBankAccount
Get Account access for User.
Returns the list of the views at BANK_ID for account ACCOUNT_ID that a user identified by PROVIDER_ID at their provider PROVIDER has access to.
All url parameters must be %-encoded , which is often especially relevant for USER_ID and PROVIDER.
Authentication is Mandatory
The user needs to have access to the owner view.
I will become the full path
Typical Successful Response:
{
"views":[{
"id":"1234",
"short_name":"short_name",
"description":"description",
"metadata_view":"owner",
"is_public":true,
"alias":"No",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_add_counterparty":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_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
}]
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-30001: Bank not found. Please specify a valid value for BANK_ID. OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID. OBP-50000: Unknown Error.
Implemented in OBPv3.0.0 by getPermissionForUserForBankAccount
Get Views for Account.
Views in Open Bank Project provide a mechanism for fine grained access control and delegation to Accounts and Transactions. Account holders use the 'owner' view by default. Delegated access is made through other views for example 'accountants', 'share-holders' or 'tagging-application'. Views can be created via the API and each view has a list of entitlements.
Views on accounts and transactions filter the underlying data to redact certain fields for certain users. For instance the balance on an account may be hidden from the public. The way to know what is possible on a view is determined in the following JSON.
Data: When a view moderates a set of data, some fields my contain the value null
rather than the original value. This indicates either that the user is not allowed to see the original data or the field is empty.
There is currently one exception to this rule; the 'holder' field in the JSON contains always a value which is either an alias or the real name - indicated by the 'is_alias' field.
Action: When a user performs an action like trying to post a comment (with POST API call), if he is not allowed, the body response will contain an error message.
Metadata:
Transaction metadata (like images, tags, comments, etc.) will appears ONLY on the view where they have been created e.g. comments posted to the public view only appear on the public view.
The other account metadata fields (like image_URL, more_info, etc.) are unique through all the views. Example, if a user edits the 'more_info' field in the 'team' view, then the view 'authorities' will show the new value (if it is allowed to do it).
Optional
Returns the list of the views created for account ACCOUNT_ID at BANK_ID.
Authentication is Mandatory and the user needs to have access to the owner view.
I will become the full path
Typical Successful Response:
{
"views":[{
"id":"1234",
"short_name":"short_name",
"description":"description",
"metadata_view":"owner",
"is_public":true,
"alias":"No",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_add_counterparty":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_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
}]
}
Possible Errors:
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.
Implemented in OBPv3.0.0 by getViewsForBankAccount
Get access.
Returns the list of the permissions at BANK_ID for account ACCOUNT_ID, with each time a pair composed of the user and the views that he has access to.
Authentication is Mandatory
and the user needs to have access to the owner view.
I will become the full path
Typical Successful Response:
{
"permissions":[{
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
},
"views":[{
"id":"123",
"short_name":"short_name",
"description":"description",
"is_public":true,
"alias":"None",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_see_bank_account_bank_name":true,
"can_see_bank_account_currency":true,
"can_see_bank_account_iban":true,
"can_see_bank_account_label":true,
"can_see_bank_account_national_identifier":true,
"can_see_bank_account_number":true,
"can_see_bank_account_owners":true,
"can_see_bank_account_swift_bic":true,
"can_see_bank_account_type":true,
"can_see_comments":true,
"can_see_corporate_location":true,
"can_see_image_url":true,
"can_see_images":true,
"can_see_more_info":true,
"can_see_open_corporates_url":true,
"can_see_other_account_bank_name":true,
"can_see_other_account_iban":true,
"can_see_other_account_kind":true,
"can_see_other_account_metadata":true,
"can_see_other_account_national_identifier":true,
"can_see_other_account_number":true,
"can_see_other_account_swift_bic":true,
"can_see_owner_comment":true,
"can_see_physical_location":true,
"can_see_private_alias":true,
"can_see_public_alias":true,
"can_see_tags":true,
"can_see_transaction_amount":true,
"can_see_transaction_balance":true,
"can_see_transaction_currency":true,
"can_see_transaction_description":true,
"can_see_transaction_finish_date":true,
"can_see_transaction_metadata":true,
"can_see_transaction_other_bank_account":true,
"can_see_transaction_start_date":true,
"can_see_transaction_this_bank_account":true,
"can_see_transaction_type":true,
"can_see_url":true,
"can_see_where_tag":true
}]
}]
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-30001: Bank not found. Please specify a valid value for BANK_ID. OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID. OBP-50000: Unknown Error.
Implemented in OBPv2.0.0 by getPermissionsForBankAccount
Grant User access to View.
Grants the User identified by PROVIDER_ID at PROVIDER access to the view VIEW_ID at BANK_ID for account ACCOUNT_ID.
All url parameters must be %-encoded , which is often especially relevant for PROVIDER and PROVIDER_ID.
Authentication is Mandatory and the user needs to have access to the owner view.
Granting access to a public view will return an error message, as the user already has access.
I will become the full path
Typical Successful Response:
{
"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
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. OBP-50000: Unknown Error. could not save the privilege user does not have access to owner view on account
Implemented in OBPv1.2.1 by addPermissionForUserForBankAccountForOneView
Grant User access to a list of views.
Grants the user identified by PROVIDER_ID at their provider PROVIDER access to a list of views at BANK_ID for account ACCOUNT_ID.
All url parameters must be %-encoded , which is often especially relevant for PROVIDER_ID and PROVIDER.
Authentication is Mandatory
The User needs to have access to the owner view.
I will become the full path
Typical Successful Response:
{
"views":[{
"id":"123",
"short_name":"short_name",
"description":"description",
"is_public":true,
"alias":"None",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_see_bank_account_bank_name":true,
"can_see_bank_account_currency":true,
"can_see_bank_account_iban":true,
"can_see_bank_account_label":true,
"can_see_bank_account_national_identifier":true,
"can_see_bank_account_number":true,
"can_see_bank_account_owners":true,
"can_see_bank_account_swift_bic":true,
"can_see_bank_account_type":true,
"can_see_comments":true,
"can_see_corporate_location":true,
"can_see_image_url":true,
"can_see_images":true,
"can_see_more_info":true,
"can_see_open_corporates_url":true,
"can_see_other_account_bank_name":true,
"can_see_other_account_iban":true,
"can_see_other_account_kind":true,
"can_see_other_account_metadata":true,
"can_see_other_account_national_identifier":true,
"can_see_other_account_number":true,
"can_see_other_account_swift_bic":true,
"can_see_owner_comment":true,
"can_see_physical_location":true,
"can_see_private_alias":true,
"can_see_public_alias":true,
"can_see_tags":true,
"can_see_transaction_amount":true,
"can_see_transaction_balance":true,
"can_see_transaction_currency":true,
"can_see_transaction_description":true,
"can_see_transaction_finish_date":true,
"can_see_transaction_metadata":true,
"can_see_transaction_other_bank_account":true,
"can_see_transaction_start_date":true,
"can_see_transaction_this_bank_account":true,
"can_see_transaction_type":true,
"can_see_url":true,
"can_see_where_tag":true
}]
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. OBP-50000: Unknown Error. wrong format JSON could not save the privilege user does not have access to owner view on account
Implemented in OBPv1.2.1 by addPermissionForUserForBankAccountForMultipleViews
Revoke access to all Views on Account
"Revokes access to all Views on an Account for a certain User.
The User is identified by PROVIDER_ID at their PROVIDER.
The Account is specified by BANK_ID and ACCOUNT_ID.
The View is specified by VIEW_ID.
PROVIDER (may be a URL so) must be URL Encoded.
PROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.
Attempting to revoke access to a public view will return an error message.
An Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.
Authentication is Mandatory and the user needs to have access to the owner view.
I will become the full path
Typical Successful Response:
{
"jsonString":"{}"
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. OBP-50000: Unknown Error. user does not have access to owner view on account
Implemented in OBPv1.2.1 by removePermissionForUserForBankAccountForAllViews
Revoke access to one View.
Revokes access to a View on an Account for a certain User.
The User is identified by PROVIDER_ID at their PROVIDER.
The Account is specified by BANK_ID and ACCOUNT_ID.
The View is specified by VIEW_ID.
PROVIDER (may be a URL so) must be URL Encoded.
PROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.
Attempting to revoke access to a public view will return an error message.
An Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.
Authentication is Mandatory and the user needs to have access to the owner view.
I will become the full path
Typical Successful Response:
{
"jsonString":"{}"
}
Possible Errors:
OBP-20001: User not logged in. Authentication is required! OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. could not save the privilege user does not have access to owner view on account OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by removePermissionForUserForBankAccountForOneView
Update View.
Update an existing view on a bank account
Authentication is Mandatory and the user needs to have access to the owner view.
The json sent is the same as during view creation (above), with one difference: the 'name' field
of a view is not editable (it is only set when a view is created)
I will become the full path
Typical Successful Response:
{
"id":"1234",
"short_name":"short_name",
"description":"description",
"metadata_view":"owner",
"is_public":true,
"alias":"No",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_add_counterparty":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_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
}
Possible Errors:
OBP-10001: Incorrect json format. OBP-20001: User not logged in. Authentication is required! OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. OBP-50000: Unknown Error.
Implemented in OBPv3.0.0 by updateViewForBankAccount