{"resource_docs":[{"operation_id":"OBPv3.0.0-getCoreTransactionsForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"getCoreTransactionsForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.0.0/my/banks/BANK_ID/accounts/ACCOUNT_ID/transactions","summary":"Get Transactions for Account (Core)","description":"
Returns transactions list (Core info) of the account specified by ACCOUNT_ID.
\nAuthentication is Mandatory
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\ncompleted: 2020-01-27
\ncurrency: EUR
\nnew_balance: 20
\nposted: 2020-01-27
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalue: 5987953
\nViews 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.
\nViews 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.
\nData: 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.
\nAction: 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.
\nMetadata:
\nTransaction 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).
\nOptional
\nReturns the list of the views created for account ACCOUNT_ID at BANK_ID.
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nGet the bank specified by BANK_ID
\nReturns information about a single bank specified by BANK_ID including:
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Get the bank specified by BANK_ID\nReturns information about a single bank specified by BANK_ID including:\n\n* Short and full name of bank\n* Logo URL\n* Website\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"id":"gh.29.uk","short_name":"short_name ","full_name":"full_name","logo":"logo","website":"www.openbankproject.com","bank_routings":[{"scheme":"Bank_ID","address":"gh.29.uk"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID."],"tags":["Bank","Account Information Service (AIS)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"website":{"type":"string"},"logo":{"type":"string"},"bank_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"short_name":{"type":"string"},"id":{"type":"string"},"full_name":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID","connector_methods":["obp.getBank"]},{"operation_id":"OBPv1.2.1-removePermissionForUserForBankAccountForAllViews","implemented_by":{"version":"OBPv1.2.1","function":"removePermissionForUserForBankAccountForAllViews"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views","summary":"Revoke access to all Views on Account","description":""Revokes access to all Views on an Account for a certain User.
\nThe User is identified by PROVIDER_ID at their PROVIDER.
\nThe Account is specified by BANK_ID and ACCOUNT_ID.
\nThe View is specified by VIEW_ID.
\nPROVIDER (may be a URL so) must be URL Encoded.
\nPROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.
\nAttempting to revoke access to a public view will return an error message.
\nAn Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"\"Revokes access to all Views on an Account for a certain User.\n\n\nThe User is identified by PROVIDER_ID at their PROVIDER.\n\nThe Account is specified by BANK_ID and ACCOUNT_ID.\n\nThe View is specified by VIEW_ID.\n\n\nPROVIDER (may be a URL so) must be URL Encoded.\n\nPROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.\n\nAttempting to revoke access to a public view will return an error message.\n\nAn Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.\n\n \n\nAuthentication is Mandatory and the user needs to have access to the owner view.\n\n\n**URL Parameters:**\n\n* [ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["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"],"tags":["View-(Custom)","Account","User","OwnerViewRequired"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views","connector_methods":["obp.checkBankAccountExists","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getFirehoseAccountsAtOneBank","implemented_by":{"version":"OBPv3.0.0","function":"getFirehoseAccountsAtOneBank"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/firehose/accounts/views/VIEW_ID","summary":"Get Firehose Accounts at Bank","description":"Get Accounts which have a firehose view assigned to them.
\nThis endpoint allows bulk access to accounts.
\nRequires the CanUseFirehoseAtAnyBank Role
\nTo be shown on the list, each Account must have a firehose View linked to it.
\nA firehose view has is_firehose = true
\nFor VIEW_ID try 'owner'
\noptional request parameters for filter with attributes
\nURL params example:
\n/banks/some-bank-id/firehose/accounts/views/owner?manager=John&count=8
to invalid Browser cache, add timestamp query parameter as follow, the parameter name must be _timestamp_
\nURL params example:
\n/banks/some-bank-id/firehose/accounts/views/owner?manager=John&count=8&_timestamp_=1596762180358
Authentication is Mandatory
\nURL Parameters:
\n\nJSON response body fields:
\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\nlabel: My Account
\nvalue: 5987953
\nReturns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [label](/glossary#can_see_bank_account_label): My Account\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Account-Public","Account","PublicData","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/public","connector_methods":["obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-updateViewForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"updateViewForBankAccount"},"request_verb":"PUT","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID","summary":"Update View","description":"Update an existing view on a bank account
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nThe json sent is the same as during view creation (above), with one difference: the 'name' field
\nof a view is not editable (it is only set when a view is created)
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nUpdate Account Attribute
\nAccount Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Account Attribute is linked to its Account by ACCOUNT_ID
\nTypical account attributes might be:
\nISIN (for International bonds)
\nVKN (for German bonds)
\nREDCODE (markit short code for credit derivative)
\nLOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
\nMATURITY_DATE (End of life time of a product)
\nTRADABLE
See FPML for more examples.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nCreate an Account Webhook
\nWebhooks are used to call external URLs when certain events happen.
\nAccount Webhooks focus on events around accounts.
\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.
\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nCreate Account Attribute
\nAccount Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Account Attribute is linked to its Account by ACCOUNT_ID
\nTypical account attributes might be:
\nISIN (for International bonds)
\nVKN (for German bonds)
\nREDCODE (markit short code for credit derivative)
\nLOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
\nMATURITY_DATE (End of life time of a product)
\nTRADABLE
See FPML for more examples.
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nJSON response body fields:
\nReturns information about a single Branch specified by BANK_ID and BRANCH_ID including:
\nAuthentication is Optional
\nURL Parameters:
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\nis_accessible: true
\nlatitude: 38.8951
\nlongitude: -77.0364
\nReturns 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.
\nAuthentication is Mandatory
\nand the user needs to have access to the owner view.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nReturns the list of accounts at BANK_ID that the user has access to.
\nFor each account the API returns the account ID and the views available to the user..
\nEach account must have at least one private View.
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Returns the list of accounts at BANK_ID that the user has access to.\nFor each account the API returns the account ID and the views available to the user..\nEach account must have at least one private View.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [label](/glossary#can_see_bank_account_label): My Account\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Account","PrivateData","PublicData","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts","connector_methods":["obp.getBankAccounts","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.0.0-publicAccountsAllBanks","implemented_by":{"version":"OBPv2.0.0","function":"publicAccountsAllBanks"},"request_verb":"GET","request_url":"/obp/v2.0.0/accounts/public","summary":"Get Public Accounts at all Banks","description":"Get public accounts at all banks (Anonymous access).
\nReturns accounts that contain at least one public view (a view where is_public is true)
\nFor each account the API returns the ID and the available views.
Authentication is Optional
\nJSON response body fields:
\n\n","description_markdown":"Get public accounts at all banks (Anonymous access).\nReturns accounts that contain at least one public view (a view where is_public is true)\nFor each account the API returns the ID and the available views.\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [label](/glossary#can_see_bank_account_label): My Account\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["OBP-30066: Could not get accounts.","OBP-50000: Unknown Error."],"tags":["Account-Public","Account","PublicData"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/accounts/public","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateAccountLabel","implemented_by":{"version":"OBPv1.2.1","function":"updateAccountLabel"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID","summary":"Update Account Label","description":"Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account'
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\nJSON response body fields:
\n","description_markdown":"Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account'\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [label](/glossary#can_see_bank_account_label): My Account\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"id":"123123","label":"label","bank_id":"gh.29.uk"},"success_response_body":{"success":"Success"},"error_response_bodies":["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"],"tags":["Account"],"typed_request_body":{"type":"object","properties":{"id":{"type":"string"},"bank_id":{"type":"string"},"label":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID","connector_methods":["obp.updateAccountLabel","obp.getBankAccountOld"]},{"operation_id":"OBPv2.1.0-createTransactionType","implemented_by":{"version":"OBPv2.1.0","function":"createTransactionType"},"request_verb":"PUT","request_url":"/obp/v2.1.0/banks/BANK_ID/transaction-types","summary":"Create Transaction Type at bank","description":"Create Transaction Types for the bank specified by BANK_ID:
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Create Transaction Types for the bank specified by BANK_ID:\n\n * id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.\n * bank_id : The bank that supports this TransactionType\n * short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here\n * summary : A succinct summary\n * description : A longer description\n * charge : The charge to the customer for each one of these\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [amount](/glossary#temporary_requested_current_amount): 10.12\n\n\n\n* [currency](/glossary#can_see_transaction_currency): EUR\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"id":{"value":"123"},"bank_id":"gh.29.uk","short_code":"PlaceholderString","summary":"PlaceholderString","description":"PlaceholderString","charge":{"currency":"EUR","amount":"0"}},"success_response_body":{"id":{"value":"123"},"bankId":{"value":"gh.uk.9j"},"shortCode":"80080","summary":"SANDBOX_TAN","description":"This is the sandbox mode, charging litter money.","charge":{"currency":"EUR","amount":"100"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-10001: Incorrect json format.","OBP-40005: Insufficient authorisation to Create Transaction Type offered by the bank. The Request could not be created because you don't have access to CanCreateTransactionType.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Bank"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"short_code":{"type":"string"},"bank_id":{"type":"string"},"summary":{"type":"string"},"charge":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"id":{"type":"object","properties":{"value":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"bankId":{"type":"object","properties":{"value":{"type":"string"}}},"charge":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"summary":{"type":"string"},"shortCode":{"type":"string"},"description":{"type":"string"},"id":{"type":"object","properties":{"value":{"type":"string"}}}}},"roles":[{"role":"CanCreateTransactionType","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/transaction-types","connector_methods":["obp.getBankLegacy"]},{"operation_id":"OBPv3.1.0-getAccountWebhooks","implemented_by":{"version":"OBPv3.1.0","function":"getAccountWebhooks"},"request_verb":"GET","request_url":"/obp/v3.1.0/management/banks/BANK_ID/account-web-hooks","summary":"Get Account Webhooks","description":"Get Account Webhooks.
\nPossible custom URL parameters for pagination:
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nGet banks on this API instance
\nReturns a list of banks supported on this server:
Authentication is Optional
\nJSON response body fields:
\n","description_markdown":"Get banks on this API instance\nReturns a list of banks supported on this server:\n\n* ID used as parameter in URLs\n* Short and full name of bank\n* Logo URL\n* Website\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"banks":[{"id":"gh.29.uk","short_name":"short_name ","full_name":"full_name","logo":"logo","website":"www.openbankproject.com","bank_routing":{"scheme":"Bank_ID","address":"gh.29.uk"}}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Bank","Account Information Service (AIS)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"banks":{"type":"array","items":{"type":"object","properties":{"website":{"type":"string"},"logo":{"type":"string"},"short_name":{"type":"string"},"id":{"type":"string"},"full_name":{"type":"string"},"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks","connector_methods":["obp.getBanks","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getPermissionForUserForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"getPermissionForUserForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID","summary":"Get Account access for User","description":"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.
\nAll url parameters must be %-encoded, which is often especially relevant for USER_ID and PROVIDER.
Authentication is Mandatory
\nThe user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nGet the Counterparties (Explicit) for the account / view.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nis_beneficiary: true
\nkey: CustomerNumber
\nvalue: 5987953
\nReturns the list of accounts containing private views for the user.
\nEach account lists the views available to the user.
optional request parameters:
\nwhole url example:
\n/my/accounts?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
\nJSON response body fields:
\naccount_type: AC
\nbank_id: gh.29.uk
\nlabel: My Account
\nGet all checkbook orders
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\naccount_type: AC
\nbank_id: gh.29.uk
\norder_date: 2020-01-27
\nReturns the minimal list of private accounts at BANK_ID that the user has access to.
\nFor 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.
\noptional request parameters:
\nwhole url example:
\n/banks/BANK_ID/accounts/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\naccount_type: AC
\nbank_id: gh.29.uk
\nlabel: My Account
\nInformation returned about the account specified by ACCOUNT_ID:
\nThis call returns the owner view and requires access to that view.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\nlabel: My Account
\nGet the Balances for the Accounts of the current User at one bank.
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\nlabel: My Account
\noverall_balance: 10
\noverall_balance_date: 2020-01-27
\nUpdate an Account Application status
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nCreate Counterparty (Explicit) for an Account.
\nIn OBP, there are two types of Counterparty.
\nExplicit Counterparties (those here) which we create explicitly and are used in COUNTERPARTY Transaction Requests
\nImplicit Counterparties (AKA Other Accounts) which are generated automatically from the other sides of Transactions.
\nExplicit Counterparties are created for the account / view
\nThey 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)
\ndescription : the human readable name (e.g. Piano teacher, Miss Nipa)
\nbank_routing_scheme : eg: bankId or bankCode or any other strings
\nbank_routing_address : eg: gh.29.uk
, must be valid sandbox bankIds
account_routing_scheme : eg: AccountId or AccountNumber or any other strings
\naccount_routing_address : eg: 1d65db7c-a7b2-4839-af41-95
, must be valid accountIds
other_account_secondary_routing_scheme : eg: IBan or any other strings
\nother_account_secondary_routing_address : if it is an IBAN, it should be unique for each counterparty.
\nother_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode.
\nother_branch_routing_address : eg: branch-id-123
or you can leave it empty, not useful in sandbox mode.
is_beneficiary : must be set to true
in order to send payments to this counterparty
bespoke: It supports a list of key-value, you can add it to the counterparty.
\nbespoke.key : any info-key you want to add to this counterparty
\nbespoke.value : any info-value you want to add to this counterparty
\nThe view specified by VIEW_ID must have the canAddCounterparty permission
\nA minimal example for TransactionRequestType == COUNTERPARTY
\n{
\n"name": "Tesobe1",
\n"description": "Good Company",
\n"other_bank_routing_scheme": "OBP",
\n"other_bank_routing_address": "gh.29.uk",
\n"other_account_routing_scheme": "OBP",
\n"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n"is_beneficiary": true,
\n"other_account_secondary_routing_scheme": "",
\n"other_account_secondary_routing_address": "",
\n"other_branch_routing_scheme": "",
\n"other_branch_routing_address": "",
\n"bespoke": []
\n}
A minimal example for TransactionRequestType == SEPA
\n{
\n"name": "Tesobe2",
\n"description": "Good Company",
\n"other_bank_routing_scheme": "OBP",
\n"other_bank_routing_address": "gh.29.uk",
\n"other_account_routing_scheme": "OBP",
\n"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n"other_account_secondary_routing_scheme": "IBAN",
\n"other_account_secondary_routing_address": "DE89 3704 0044 0532 0130 00",
\n"is_beneficiary": true,
\n"other_branch_routing_scheme": "",
\n"other_branch_routing_address": "",
\n"bespoke": []
\n}
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nis_beneficiary: true
\nkey: CustomerNumber
\nvalue: 5987953
\nJSON response body fields:
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate: 2020-01-27
\nis_beneficiary: true
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\nusername: felixsmith
\nvalue: 5987953
\nCreate a view on bank account
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nThe 'alias' field in the JSON can take one of three values:
''(empty string): to use no alias; the view shows the real name of the other account.
\nThe '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.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nJSON response body fields:
\nGet the list of the Transaction Request Types supported by the bank.
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\nCreate a new bank (Authenticated access).
\nAuthentication is Mandatory
JSON request body fields:
\nlogo_url: logo_url
\nwebsite_url: website_url
\nJSON response body fields:
\nlogo_url: logo_url
\nwebsite_url: website_url
\nGet Transaction Types for the bank specified by BANK_ID:
\nLists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Get Transaction Types for the bank specified by BANK_ID:\n\nLists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).\n\n * id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.\n * bank_id : The bank that supports this TransactionType\n * short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here\n * summary : A succinct summary\n * description : A longer description\n * charge : The charge to the customer for each one of these\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [amount](/glossary#temporary_requested_current_amount): 10.12\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [currency](/glossary#can_see_transaction_currency): EUR\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"transaction_types":[{"id":{"value":"123"},"bank_id":"gh.29.uk","short_code":"PlaceholderString","summary":"PlaceholderString","description":"PlaceholderString","charge":{"currency":"EUR","amount":"0"}}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Bank","Account Information Service (AIS)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"transaction_types":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"short_code":{"type":"string"},"bank_id":{"type":"string"},"summary":{"type":"string"},"charge":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"id":{"type":"object","properties":{"value":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/transaction-types","connector_methods":["obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getTransactionsForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"getTransactionsForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions","summary":"Get Transactions for Account (Full)","description":"Returns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID).
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\namount: 10.12
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndate: 2020-01-27
\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\nnew_balance: 20
\nposted: 2020-01-27
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalue: 5987953
\nReturns only the list of accounts ids at BANK_ID that the user has access to.
\nEach account must have at least one private View.
\nFor each account the API returns its account ID.
\nIf you want to see more information on the Views, use the Account Detail call.
\noptional request parameters:
\nwhole url example:
\n/banks/BANK_ID/accounts/account_ids/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Returns only the list of accounts ids at BANK_ID that the user has access to.\n\nEach account must have at least one private View.\n\nFor each account the API returns its account ID.\n\nIf you want to see more information on the Views, use the Account Detail call.\n\n\noptional request parameters:\n\n* account_type_filter: one or many accountType value, split by comma\n* account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE\n\nwhole url example:\n/banks/BANK_ID/accounts/account_ids/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf"}]},"error_response_bodies":["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."],"tags":["Account","Account Information Service (AIS)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/account_ids/private","connector_methods":["obp.getCoreBankAccounts","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-createAccount","implemented_by":{"version":"OBPv3.1.0","function":"createAccount"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID","summary":"Create Account","description":"Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.
\nThe User can create an Account for themself - or - the User that has the USER_ID specified in the POST body.
\nIf 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.
\nIf the PUT body USER_ID is not specified, the account will be owned by the logged in User.
\nThe 'product_code' field SHOULD be a product_code from Product.
\nIf the 'product_code' matches a product_code from Product, account attributes will be created that match the Product Attributes.
Note: The Amount MUST be zero.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nGrants the User identified by PROVIDER_ID at PROVIDER access to the view VIEW_ID at BANK_ID for account ACCOUNT_ID.
\nAll url parameters must be %-encoded, which is often especially relevant for PROVIDER and PROVIDER_ID.
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nGranting access to a public view will return an error message, as the user already has access.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nJSON response body fields:
\nCreate Account Application
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nUpdate the account.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\nlabel: My Account
\nGrants the user identified by PROVIDER_ID at their provider PROVIDER access to a list of views at BANK_ID for account ACCOUNT_ID.
\nAll url parameters must be %-encoded, which is often especially relevant for PROVIDER_ID and PROVIDER.
\nAuthentication is Mandatory
\nThe User needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nJSON response body fields:
\nGet the Account Application.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nEnable/Disable an Account Webhook
\nWebhooks are used to call external URLs when certain events happen.
\nAccount Webhooks focus on events around accounts.
\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.
\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nInformation returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):
\nMore details about the data moderation by the view here.
\nPSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
\nThis call provides balance and other account information via delegated authentication using OAuth.
Authentication is required if the 'is_public' field in view (VIEW_ID) is not set to true
.
Authentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncan_see_images: true
\ncurrency: EUR
\nlabel: My Account
\nvalue: 5987953
\nDeletes the view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["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"],"tags":["View-(Custom)","Account","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID","connector_methods":["obp.checkBankAccountExists","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getPublicAccountById","implemented_by":{"version":"OBPv3.0.0","function":"getPublicAccountById"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/public/accounts/ACCOUNT_ID/VIEW_ID/account","summary":"Get Public Account by Id","description":"Returns information about an account that has a public view.
\nThe account is specified by ACCOUNT_ID. The information is moderated by the view specified by VIEW_ID.
\nPSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
\nThis call provides balance and other account information via delegated authentication using OAuth.
Authentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\nlabel: My Account
\nvalue: 5987953
\nGet the Account Applications.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nReturns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID.
\nAuthentication is Optional
Authentication is required if the view VIEW_ID is not public.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID.\nAuthentication is Optional\n\nAuthentication is required if the view VIEW_ID is not public.\n\n\n**URL Parameters:**\n\n* [ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [URL](/glossary#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n\n* [date](/glossary#effective_date): 2020-01-27\n\n\n\n* [latitude](/glossary#latitude): 38.8951\n\n\n\n* [longitude](/glossary#longitude): -77.0364\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}}}]},"error_response_bodies":["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."],"tags":["Counterparty","Account","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"other_accounts":{"type":"array","items":{"type":"object","properties":{"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"corporate_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getOtherAccountByIdForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"getOtherAccountByIdForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID","summary":"Get Other Account by Id","description":"Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID.
\nAuthentication is Optional
Authentication is required if the view is not public.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID.\nAuthentication is Optional\n\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n* [ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [URL](/glossary#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n\n* [date](/glossary#effective_date): 2020-01-27\n\n\n\n* [latitude](/glossary#latitude): 38.8951\n\n\n\n* [longitude](/glossary#longitude): -77.0364\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}}},"error_response_bodies":["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."],"tags":["Counterparty","Account","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"corporate_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv1.2.1-removePermissionForUserForBankAccountForOneView","implemented_by":{"version":"OBPv1.2.1","function":"removePermissionForUserForBankAccountForOneView"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views/VIEW_ID","summary":"Revoke access to one View","description":"Revokes access to a View on an Account for a certain User.
\nThe User is identified by PROVIDER_ID at their PROVIDER.
\nThe Account is specified by BANK_ID and ACCOUNT_ID.
\nThe View is specified by VIEW_ID.
\nPROVIDER (may be a URL so) must be URL Encoded.
\nPROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.
\nAttempting to revoke access to a public view will return an error message.
\nAn Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Revokes access to a View on an Account for a certain User.\n\n\nThe User is identified by PROVIDER_ID at their PROVIDER.\n\nThe Account is specified by BANK_ID and ACCOUNT_ID.\n\nThe View is specified by VIEW_ID.\n\n\nPROVIDER (may be a URL so) must be URL Encoded.\n\nPROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.\n\nAttempting to revoke access to a public view will return an error message.\n\nAn Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.\n\n \n\nAuthentication is Mandatory and the user needs to have access to the owner view.\n\n\n**URL Parameters:**\n\n* [ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["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."],"tags":["View-(Custom)","Account","User","Entitlement","OwnerViewRequired"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views/VIEW_ID","connector_methods":["obp.checkBankAccountExists","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getAccountsHeld","implemented_by":{"version":"OBPv3.0.0","function":"getAccountsHeld"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts-held","summary":"Get Accounts Held","description":"Get Accounts held by the current User if even the User has not been assigned the owner View yet.
\nCan be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.
\noptional request parameters:
\nwhole url example:
\n/banks/BANK_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Get Accounts held by the current User if even the User has not been assigned the owner View yet.\n\nCan be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.\n\n\noptional request parameters:\n\n* account_type_filter: one or many accountType value, split by comma\n* account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE\n\nwhole url example:\n/banks/BANK_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE\n \n\n\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [label](/glossary#can_see_bank_account_label): My Account\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"12314","label":"My Account","bank_id":"123","number":"123","account_routings":[{"scheme":"AccountNumber","address":"4930396"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account","Account Information Service (AIS)","View-(Custom)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string"},"label":{"type":"string"},"bank_id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts-held","connector_methods":["obp.getCoreBankAccounts","obp.getBankAccountsHeld","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getBranches","implemented_by":{"version":"OBPv3.0.0","function":"getBranches"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/branches","summary":"Get Branches for a Bank","description":"Returns information about branches for a single bank specified by BANK_ID including:
\nPagination:
\nBy default, 50 records are returned.
\nYou can use the url query parameters limit and offset for pagination
\nYou can also use the follow url query parameters:
city - string, find Branches those in this city, optional
\nwithinMetersOf - number, find Branches within given meters distance, optional
\nnote: withinMetersOf, nearLatitude and nearLongitude either all empty or all have value.
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\nis_accessible: true
\nlatitude: 38.8951
\nlongitude: -77.0364
\nCheck Available Funds
\nMandatory URL parameters:
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n