{"resource_docs":[{"operation_id":"OBPv5.0.0-updateBank","implemented_by":{"version":"OBPv5.0.0","function":"updateBank"},"request_verb":"PUT","request_url":"/obp/v5.0.0/banks","summary":"Update Bank","description":"
Update an existing bank (Authenticated access).
\nAuthentication is Mandatory
\nJSON response body fields:
\n\nbank_code: CGHZ
\nbank_routings: bank routing in form of (scheme, address)
\nfull_name: full name string
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlogo: logo url
\nname: ACCOUNT_MANAGEMENT_FEE
\nscheme: scheme value
\nvalue: 5987953
\nwebsite: www.openbankproject.com
\nattributes: attribute value in form of (name, value)
\n","description_markdown":"Update an existing bank (Authenticated access).\n\n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_routings**](/glossary#bank_routings): bank routing in form of (scheme, address)\n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**logo**](/glossary#logo): logo url\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**website**](/glossary#website): www.openbankproject.com\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n","example_request_body":{"id":"gh.29.uk","bank_code":"CGHZ","full_name":"full name string","logo":"logo url","website":"www.openbankproject.com","bank_routings":[{"scheme":"scheme value","address":""}]},"success_response_body":{"id":"gh.29.uk","bank_code":"CGHZ","full_name":"bank fullName string","logo":"bank logoUrl string","website":"bank logoUrl string","bank_routings":[{"scheme":"scheme value","address":""}],"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-34001: Could not update the Bank","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Bank"],"typed_request_body":{"type":"object","properties":{"bank_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"full_name":{"type":"string"},"logo":{"type":"string"},"id":{"type":"string"},"bank_code":{"type":"string"},"website":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"website":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"bank_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"logo":{"type":"string"},"bank_code":{"type":"string"},"full_name":{"type":"string"},"id":{"type":"string"}}},"roles":[{"role":"CanCreateBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks","connector_methods":[]},{"operation_id":"OBPv4.0.0-createOrUpdateBankAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"createOrUpdateBankAttributeDefinition"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/bank","summary":"Create or Update Bank Attribute Definition","description":"Create or Update Bank Attribute Definition
\nThe category field must be Bank
\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: true
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_active: true
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Create or Update Bank Attribute Definition\n\nThe category field must be Bank\n\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY\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[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): true\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"name":"SPECIAL_TAX_NUMBER","category":"Bank","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true},"success_response_body":{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"Bank","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true},"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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Bank"],"typed_request_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"roles":[{"role":"CanCreateBankAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/bank","connector_methods":[]},{"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:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\nis_active: true
\n\nurl: http://www.example.com/id-docs/123/image.png
\n\n","description_markdown":"Get Account Webhooks.\n\nPossible custom URL parameters for pagination:\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 500\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n\n* account_id=STRING (if null ignore)\n* user_id=STRING (if null ignore)\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[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_webhook_id**](/glossary#account_webhook_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**web_hooks**](/glossary#web_hooks): \n\n\n","success_response_body":{"web_hooks":[{"account_webhook_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","trigger_name":"OnBalanceChange","url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","is_active":true}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Webhook","Bank"],"typed_success_response_body":{"type":"object","properties":{"web_hooks":{"type":"array","items":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"account_webhook_id":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}}}}},"roles":[{"role":"CanGetWebhooks","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/account-web-hooks","connector_methods":[]},{"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:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\n\n\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: true
\nlatitude: 38.8951
\n\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\nscheme: scheme value
\n\n\n\n\n\n","description_markdown":"Returns information about branches for a single bank specified by BANK_ID including:\n\n* Name\n* Address\n* Geo Location\n* License the data under this endpoint is released under\n* Structured opening hours\n* Accessible flag\n* Branch Type\n* More Info\n\nPagination:\n\nBy default, 50 records are returned.\n\nYou can use the url query parameters *limit* and *offset* for pagination\nYou can also use the follow url query parameters:\n\n - city - string, find Branches those in this city, optional\n\n\n - withinMetersOf - number, find Branches within given meters distance, optional\n - nearLatitude - number, a position of latitude value, cooperate with withMetersOf do query filter, optional\n - nearLongitude - number, a position of longitude value, cooperate with withMetersOf do query filter, optional\n\nnote: withinMetersOf, nearLatitude and nearLongitude either all empty or all have value.\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[**accessibleFeatures**](/glossary#accessiblefeatures): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_routing**](/glossary#branch_routing): \n\n\n\n[**branch_type**](/glossary#branch_type): \n\n\n\n[**branches**](/glossary#branches): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**closing_time**](/glossary#closing_time): 2020-01-27\n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**drive_up**](/glossary#drive_up): \n\n\n\n[**friday**](/glossary#friday): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_accessible**](/glossary#): true\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**lobby**](/glossary#lobby): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**monday**](/glossary#monday): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**opening_time**](/glossary#opening_time): \n\n\n\n[**phone_number**](/glossary#phone_number): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**saturday**](/glossary#saturday): \n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**state**](/glossary#state): \n\n\n\n[**sunday**](/glossary#sunday): \n\n\n\n[**thursday**](/glossary#thursday): \n\n\n\n[**tuesday**](/glossary#tuesday): \n\n\n\n[**wednesday**](/glossary#wednesday): \n\n\n","success_response_body":{"branches":[{"id":"branch-id-123","bank_id":"bank-id-123","name":"Branch by the Lake","address":{"line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"String","state":"Brandenburg","postcode":"13359","country_code":"DE"},"location":{"latitude":10.0,"longitude":10.0},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"lobby":{"monday":[{"opening_time":"10:00","closing_time":"18:00"}],"tuesday":[{"opening_time":"10:00","closing_time":"18:00"}],"wednesday":[{"opening_time":"10:00","closing_time":"18:00"}],"thursday":[{"opening_time":"10:00","closing_time":"18:00"}],"friday":[{"opening_time":"10:00","closing_time":"18:00"}],"saturday":[{"opening_time":"10:00","closing_time":"18:00"}],"sunday":[{"opening_time":"10:00","closing_time":"18:00"}]},"drive_up":{"monday":{"opening_time":"10:00","closing_time":"18:00"},"tuesday":{"opening_time":"10:00","closing_time":"18:00"},"wednesday":{"opening_time":"10:00","closing_time":"18:00"},"thursday":{"opening_time":"10:00","closing_time":"18:00"},"friday":{"opening_time":"10:00","closing_time":"18:00"},"saturday":{"opening_time":"10:00","closing_time":"18:00"},"sunday":{"opening_time":"10:00","closing_time":"18:00"}},"branch_routing":{"scheme":"OBP","address":"123abc"},"is_accessible":"true","accessibleFeatures":"wheelchair, atm usuable by the visually impaired","branch_type":"Full service store","more_info":"short walk to the lake from here","phone_number":"+381631954907"}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-32001: No branches available. License may not be set.","OBP-50000: Unknown Error."],"tags":["Branch","Bank"],"typed_success_response_body":{"type":"object","properties":{"branches":{"type":"array","items":{"type":"object","properties":{"accessibleFeatures":{"type":"string"},"more_info":{"type":"string"},"branch_type":{"type":"string"},"name":{"type":"string"},"bank_id":{"type":"string"},"location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"county":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"}}},"drive_up":{"type":"object","properties":{"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"phone_number":{"type":"string"},"lobby":{"type":"object","properties":{"saturday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"tuesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"monday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"friday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"sunday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"wednesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"thursday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/branches","connector_methods":[]},{"operation_id":"OBPv5.0.0-createBank","implemented_by":{"version":"OBPv5.0.0","function":"createBank"},"request_verb":"POST","request_url":"/obp/v5.0.0/banks","summary":"Create Bank","description":"Create a new bank (Authenticated access).
\nThe user creating this will be automatically assigned the Role CanCreateEntitlementAtOneBank.
\nThus the User can manage the bank they create and assign Roles to other Users.
Only SANDBOX mode
\nThe settlement accounts are created specified by the bank in the POST body.
\nName and account id are created in accordance to the next rules:
\n- Incoming account (name: Default incoming settlement account, Account ID: OBP_DEFAULT_INCOMING_ACCOUNT_ID, currency: EUR)
\n- Outgoing account (name: Default outgoing settlement account, Account ID: OBP_DEFAULT_OUTGOING_ACCOUNT_ID, currency: EUR)
Authentication is Mandatory
\nJSON request body fields:
\n\nbank_code: CGHZ
\nscheme: scheme value
\nbank_routings: bank routing in form of (scheme, address)
\nfull_name: full name string
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlogo: logo url
\nwebsite: www.openbankproject.com
\nJSON response body fields:
\n\nbank_code: CGHZ
\nbank_routings: bank routing in form of (scheme, address)
\nfull_name: full name string
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlogo: logo url
\nname: ACCOUNT_MANAGEMENT_FEE
\nscheme: scheme value
\nvalue: 5987953
\nwebsite: www.openbankproject.com
\nattributes: attribute value in form of (name, value)
\n","description_markdown":"Create a new bank (Authenticated access).\n\nThe user creating this will be automatically assigned the Role CanCreateEntitlementAtOneBank.\nThus the User can manage the bank they create and assign Roles to other Users.\n\nOnly SANDBOX mode\nThe settlement accounts are created specified by the bank in the POST body.\nName and account id are created in accordance to the next rules:\n - Incoming account (name: Default incoming settlement account, Account ID: OBP_DEFAULT_INCOMING_ACCOUNT_ID, currency: EUR)\n - Outgoing account (name: Default outgoing settlement account, Account ID: OBP_DEFAULT_OUTGOING_ACCOUNT_ID, currency: EUR)\n\n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[bank_routings](/glossary#bank_routings): bank routing in form of (scheme, address)\n\n\n\n[full_name](/glossary#full_name): full name string\n\n\n\n[id](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[logo](/glossary#logo): logo url\n\n\n\n[website](/glossary#website): www.openbankproject.com\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_routings**](/glossary#bank_routings): bank routing in form of (scheme, address)\n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**logo**](/glossary#logo): logo url\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**website**](/glossary#website): www.openbankproject.com\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n","example_request_body":{"id":"gh.29.uk","bank_code":"CGHZ","full_name":"full name string","logo":"logo url","website":"www.openbankproject.com","bank_routings":[{"scheme":"scheme value","address":""}]},"success_response_body":{"id":"gh.29.uk","bank_code":"CGHZ","full_name":"bank fullName string","logo":"bank logoUrl string","website":"bank logoUrl string","bank_routings":[{"scheme":"scheme value","address":""}],"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-20001: User not logged in. Authentication is required!","OBP-30210: Insufficient authorisation to Create Bank. You do not have the role CanCreateBank.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Bank"],"typed_request_body":{"type":"object","properties":{"bank_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"full_name":{"type":"string"},"logo":{"type":"string"},"id":{"type":"string"},"bank_code":{"type":"string"},"website":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"website":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"bank_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"logo":{"type":"string"},"bank_code":{"type":"string"},"full_name":{"type":"string"},"id":{"type":"string"}}},"roles":[{"role":"CanCreateBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks","connector_methods":[]},{"operation_id":"OBPv4.0.0-createBankAccountNotificationWebhook","implemented_by":{"version":"OBPv4.0.0","function":"createBankAccountNotificationWebhook"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/web-hooks/account/notifications/on-create-transaction","summary":"Create bank level Account Notification Webhook","description":"Create a notification Webhook that will fire for all accounts on the specified Bank.
\nWebhooks are used to call external web services when certain events happen.
\nFor instance, a webhook can be used to notify an external service if a transaction is created on an account.
\nWhen an account notification webhook fires it will POST to the URL you specify during the creation of the webhook.
\nInside the payload you will find account_id and transaction_id and also user_ids and customer_ids of the Users / Customers linked to the Account.
\nThe webhook will POST the following structure to your service:
\n{
\n"event_name": "OnCreateTransaction",
\n"event_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"bank_id": "gh.29.uk",
\n"account_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"transaction_id": "7ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"related_entities": [
\n{
\n"user_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"customer_ids": ["3ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"]
\n}
\n]
\n}
Thus, your service should accept the above POST body structure.
\nIn this way, your web service can be informed about an event on an account and act accordingly.
\nFurther information about the account, transaction or related entities can then be retrieved using the standard REST APIs.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nhttp_method: GET
\n\nurl: http://www.example.com/id-docs/123/image.png
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nwebhook_id: webhook_id
\n","description_markdown":"Create a notification Webhook that will fire for all accounts on the specified Bank.\n\n\nWebhooks are used to call external web services when certain events happen.\n\nFor instance, a webhook can be used to notify an external service if a transaction is created on an account.\n\n\n\n\nWhen an account notification webhook fires it will POST to the URL you specify during the creation of the webhook.\n\nInside the payload you will find account_id and transaction_id and also user_ids and customer_ids of the Users / Customers linked to the Account.\n |\nThe webhook will POST the following structure to your service:\n\n{\n \"event_name\": \"OnCreateTransaction\",\n \"event_id\": \"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"bank_id\": \"gh.29.uk\",\n \"account_id\": \"8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"transaction_id\": \"7ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"related_entities\": [\n {\n \"user_id\": \"8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"customer_ids\": [\"3ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\"]\n }\n ]\n}\n\nThus, your service should accept the above POST body structure.\n\nIn this way, your web service can be informed about an event on an account and act accordingly.\n\nFurther information about the account, transaction or related entities can then be retrieved using the standard REST APIs.\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 request body fields:**\n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**webhook_id**](/glossary#): webhook_id\n\n\n","example_request_body":{"url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1"},"success_response_body":{"webhook_id":"fc23a7e2-7dd2-4bdf-a0b4-ae31232a4762","bank_id":"gh.29.uk","trigger_name":"OnCreateTransaction","url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"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.","OBP-20006: User is missing one or more roles: "],"tags":["Webhook","Bank"],"typed_request_body":{"type":"object","properties":{"http_method":{"type":"string"},"http_protocol":{"type":"string"},"url":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"webhook_id":{"type":"string"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"trigger_name":{"type":"string"},"url":{"type":"string"}}},"roles":[{"role":"CanCreateAccountNotificationWebhookAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/web-hooks/account/notifications/on-create-transaction","connector_methods":[]},{"operation_id":"OBPv4.0.0-createSystemAccountNotificationWebhook","implemented_by":{"version":"OBPv4.0.0","function":"createSystemAccountNotificationWebhook"},"request_verb":"POST","request_url":"/obp/v4.0.0/web-hooks/account/notifications/on-create-transaction","summary":"Create system level Account Notification Webhook","description":"Create a notification Webhook that will fire for all accounts on the system.
\nWebhooks are used to call external web services when certain events happen.
\nFor instance, a webhook can be used to notify an external service if a transaction is created on an account.
\nWhen an account notification webhook fires it will POST to the URL you specify during the creation of the webhook.
\nInside the payload you will find account_id and transaction_id and also user_ids and customer_ids of the Users / Customers linked to the Account.
\nThe webhook will POST the following structure to your service:
\n{
\n"event_name": "OnCreateTransaction",
\n"event_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"bank_id": "gh.29.uk",
\n"account_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"transaction_id": "7ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"related_entities": [
\n{
\n"user_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"customer_ids": ["3ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"]
\n}
\n]
\n}
Thus, your service should accept the above POST body structure.
\nIn this way, your web service can be informed about an event on an account and act accordingly.
\nFurther information about the account, transaction or related entities can then be retrieved using the standard REST APIs.
\nAuthentication is Mandatory
\nJSON request body fields:
\nhttp_method: GET
\n\nurl: http://www.example.com/id-docs/123/image.png
\nJSON response body fields:
\n\nhttp_method: GET
\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nwebhook_id: webhook_id
\n","description_markdown":"Create a notification Webhook that will fire for all accounts on the system.\n\n\nWebhooks are used to call external web services when certain events happen.\n\nFor instance, a webhook can be used to notify an external service if a transaction is created on an account.\n\n\n\n\nWhen an account notification webhook fires it will POST to the URL you specify during the creation of the webhook.\n\nInside the payload you will find account_id and transaction_id and also user_ids and customer_ids of the Users / Customers linked to the Account.\n |\nThe webhook will POST the following structure to your service:\n\n{\n \"event_name\": \"OnCreateTransaction\",\n \"event_id\": \"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"bank_id\": \"gh.29.uk\",\n \"account_id\": \"8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"transaction_id\": \"7ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"related_entities\": [\n {\n \"user_id\": \"8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"customer_ids\": [\"3ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\"]\n }\n ]\n}\n\nThus, your service should accept the above POST body structure.\n\nIn this way, your web service can be informed about an event on an account and act accordingly.\n\nFurther information about the account, transaction or related entities can then be retrieved using the standard REST APIs.\n\n\n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**webhook_id**](/glossary#): webhook_id\n\n\n","example_request_body":{"url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1"},"success_response_body":{"webhook_id":"fc23a7e2-7dd2-4bdf-a0b4-ae31232a4762","trigger_name":"OnCreateTransaction","url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Webhook","Bank"],"typed_request_body":{"type":"object","properties":{"http_method":{"type":"string"},"http_protocol":{"type":"string"},"url":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"webhook_id":{"type":"string"},"http_protocol":{"type":"string"},"trigger_name":{"type":"string"},"url":{"type":"string"}}},"roles":[{"role":"CanCreateSystemAccountNotificationWebhook","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/web-hooks/account/notifications/on-create-transaction","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateBankAttribute","implemented_by":{"version":"OBPv4.0.0","function":"updateBankAttribute"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/attributes/BANK_ATTRIBUTE_ID","summary":"Update Bank Attribute","description":"Update Bank Attribute.
\nUpdate one Bak Attribute by its id.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ATTRIBUTE_ID: BANK_ATTRIBUTE_ID
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\ncan_be_seen_on_views: true
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_active: true
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Update Bank Attribute. \n\nUpdate one Bak Attribute by its id.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ATTRIBUTE_ID](/glossary#): BANK_ATTRIBUTE_ID\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\n[**alias**](/glossary#alias): \n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): true\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"name":"TAX_ID","type":"INTEGER","value":"12345678","is_active":true},"success_response_body":{"name":"SPECIAL_TAX_NUMBER","category":"Bank","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Bank"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"type":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attributes/BANK_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createBankAttribute","implemented_by":{"version":"OBPv4.0.0","function":"createBankAttribute"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute","summary":"Create Bank Attribute","description":"Create Bank Attribute
\nTypical product 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:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: true
\nJSON response body fields:
\nbank_attribute_id: bank_attribute_id
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: true
\n","description_markdown":"Create Bank Attribute\n\nTypical product attributes might be:\n\nISIN (for International bonds)\nVKN (for German bonds)\nREDCODE (markit short code for credit derivative)\nLOAN_ID (e.g. used for Anacredit reporting)\n\nISSUE_DATE (When the bond was issued in the market)\nMATURITY_DATE (End of life time of a product)\nTRADABLE\n\nSee [FPML](http://www.fpml.org/) for more examples.\n\n\nThe type field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\" or DATE_WITH_DAY\"\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 request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): true\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_attribute_id**](/glossary#): bank_attribute_id\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): true\n\n\n","example_request_body":{"name":"TAX_ID","type":"INTEGER","value":"12345678","is_active":true},"success_response_body":{"bank_id":"gh.29.uk","bank_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","is_active":true},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Bank"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"type":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"},"bank_attribute_id":{"type":"string"}}},"roles":[{"role":"CanCreateBankAttribute","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute","connector_methods":[]},{"operation_id":"OBPv3.1.0-createAccountWebhook","implemented_by":{"version":"OBPv3.1.0","function":"createAccountWebhook"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/account-web-hooks","summary":"Create an Account Webhook","description":"Create 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:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nhttp_method: GET
\n\nis_active: true
\n\nurl: http://www.example.com/id-docs/123/image.png
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\nis_active: true
\n\nurl: http://www.example.com/id-docs/123/image.png
\n","description_markdown":"Create an Account Webhook\n\nWebhooks are used to call external URLs when certain events happen.\n\nAccount Webhooks focus on events around accounts.\n\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.\n\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange\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 request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_webhook_id**](/glossary#account_webhook_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n","example_request_body":{"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","trigger_name":"OnBalanceChange","url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1","is_active":"true"},"success_response_body":{"account_webhook_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","trigger_name":"OnBalanceChange","url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","is_active":true},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Webhook","Bank"],"typed_request_body":{"type":"object","properties":{"http_method":{"type":"string"},"is_active":{"type":"string"},"http_protocol":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"account_webhook_id":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}},"roles":[{"role":"CanCreateWebhook","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/account-web-hooks","connector_methods":[]},{"operation_id":"OBPv4.0.0-getSettlementAccounts","implemented_by":{"version":"OBPv4.0.0","function":"getSettlementAccounts"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/settlement-accounts","summary":"Get Settlement accounts at Bank","description":"Get settlement accounts on this API instance
\nReturns a list of settlement accounts at this Bank
Note: a settlement account is considered as a bank account.
\nSo you can update it and add account attributes to it using the regular account endpoints
Authentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\npayment_system: SEPA
\nproduct_code: 1234BW
\nscheme: scheme value
\n\ntype:
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\n","description_markdown":"Get settlement accounts on this API instance\nReturns a list of settlement accounts at this Bank\n\nNote: a settlement account is considered as a bank account.\nSo you can update it and add account attributes to it using the regular account endpoints\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[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**account_attributes**](/glossary#account_attributes): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**payment_system**](/glossary#): SEPA\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**settlement_accounts**](/glossary#settlement_accounts): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[product_instance_code](/glossary#): product_instance_code\n\n\n","success_response_body":{"settlement_accounts":[{"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","payment_system":"SEPA","balance":{"currency":"EUR","amount":"0"},"label":"My Account","branch_id":"DERBY6","account_routings":[{"scheme":"AccountNumber","address":"4930396"}],"account_attributes":[{"product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","product_instance_code":"LKJL98769F"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Bank","PSD2"],"typed_success_response_body":{"type":"object","properties":{"settlement_accounts":{"type":"array","items":{"type":"object","properties":{"payment_system":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"branch_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetSettlementAccountAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/settlement-accounts","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteBankCascade","implemented_by":{"version":"OBPv4.0.0","function":"deleteBankCascade"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/cascading/banks/BANK_ID","summary":"Delete Bank Cascade","description":"Delete a Bank Cascade specified by BANK_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete a Bank Cascade specified by BANK_ID.\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","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-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Bank"],"roles":[{"role":"CanDeleteBankCascade","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/cascading/banks/BANK_ID","connector_methods":[]},{"operation_id":"OBPv2.1.0-getTransactionRequestTypesSupportedByBank","implemented_by":{"version":"OBPv2.1.0","function":"getTransactionRequestTypesSupportedByBank"},"request_verb":"GET","request_url":"/obp/v2.1.0/banks/BANK_ID/transaction-request-types","summary":"Get Transaction Request Types at Bank","description":"Get the list of the Transaction Request Types supported by the bank.
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ntransaction_request_type: SEPA
\n\n","description_markdown":"Get the list of the Transaction Request Types supported by the bank.\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[**transaction_request_type**](/glossary#): SEPA\n\n\n\n[**transaction_request_types**](/glossary#transaction_request_types): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"transaction_request_types":[{"transaction_request_type":"SandboxTan"}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Transaction-Request","Bank"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"transaction_request_types":{"type":"array","items":{"type":"object","properties":{"transaction_request_type":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/transaction-request-types","connector_methods":[]},{"operation_id":"OBPv4.0.0-getBankAttributes","implemented_by":{"version":"OBPv4.0.0","function":"getBankAttributes"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/attributes","summary":"Get Bank Attributes","description":"Get Bank Attributes
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_attribute_id: bank_attribute_id
\nbank_attributes: bank_attributes
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: true
\n","description_markdown":"Get Bank Attributes\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_attribute_id**](/glossary#): bank_attribute_id\n\n\n\n[**bank_attributes**](/glossary#): bank_attributes\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): true\n\n\n","success_response_body":{"bank_attributes":[{"bank_id":"gh.29.uk","bank_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","is_active":true}]},"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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Bank"],"typed_success_response_body":{"type":"object","properties":{"bank_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"},"bank_attribute_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetBankAttribute","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attributes","connector_methods":[]},{"operation_id":"OBPv4.0.0-createSettlementAccount","implemented_by":{"version":"OBPv4.0.0","function":"createSettlementAccount"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/settlement-accounts","summary":"Create Settlement Account","description":"Create a new settlement account at a bank.
\nThe created settlement account id will be the concatenation of the payment system and the account currency.
\nFor examples: SEPA_SETTLEMENT_ACCOUNT_EUR, CARD_SETTLEMENT_ACCOUNT_USD
By default, when you create a new bank, two settlements accounts are created automatically: OBP_DEFAULT_INCOMING_ACCOUNT_ID and OBP_DEFAULT_OUTGOING_ACCOUNT_ID
\nThose two accounts have EUR as default currency.
If you want to create default settlement account for a specific currency, you can fill the payment_system
field with the DEFAULT
value.
When a transaction is saved in OBP through the mapped connector, OBP-API look for the account to save the double-entry transaction.
\nIf no OBP account can be found from the counterparty, the double-entry transaction will be saved on a bank settlement account.
\n- First, the mapped connector looks for a settlement account specific to the payment system and currency. E.g SEPA_SETTLEMENT_ACCOUNT_EUR.
\n- If we don't find any specific settlement account with the payment system, we look for a default settlement account for the counterparty currency. E.g DEFAULT_SETTLEMENT_ACCOUNT_EUR.
\n- Else, we select one of the two OBP default settlement accounts (OBP_DEFAULT_INCOMING_ACCOUNT_ID/OBP_DEFAULT_OUTGOING_ACCOUNT_ID) according to the transaction direction.
If the POST body USER_ID is specified, the logged in user must have the Role CanCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.
\nIf the POST body USER_ID is not specified, the account will be owned by the logged in User.
\nNote: The Amount MUST be zero.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\npayment_system: SEPA
\nscheme: scheme value
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\npayment_system: SEPA
\nproduct_code: 1234BW
\nscheme: scheme value
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\n","description_markdown":"Create a new settlement account at a bank.\n\nThe created settlement account id will be the concatenation of the payment system and the account currency.\nFor examples: SEPA_SETTLEMENT_ACCOUNT_EUR, CARD_SETTLEMENT_ACCOUNT_USD\n\nBy default, when you create a new bank, two settlements accounts are created automatically: OBP_DEFAULT_INCOMING_ACCOUNT_ID and OBP_DEFAULT_OUTGOING_ACCOUNT_ID\nThose two accounts have EUR as default currency.\n\nIf you want to create default settlement account for a specific currency, you can fill the `payment_system` field with the `DEFAULT` value.\n\nWhen a transaction is saved in OBP through the mapped connector, OBP-API look for the account to save the double-entry transaction.\nIf no OBP account can be found from the counterparty, the double-entry transaction will be saved on a bank settlement account.\n- First, the mapped connector looks for a settlement account specific to the payment system and currency. E.g SEPA_SETTLEMENT_ACCOUNT_EUR.\n- If we don't find any specific settlement account with the payment system, we look for a default settlement account for the counterparty currency. E.g DEFAULT_SETTLEMENT_ACCOUNT_EUR.\n- Else, we select one of the two OBP default settlement accounts (OBP_DEFAULT_INCOMING_ACCOUNT_ID/OBP_DEFAULT_OUTGOING_ACCOUNT_ID) according to the transaction direction.\n\nIf the POST body USER_ID *is* specified, the logged in user must have the Role CanCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.\n\nIf the POST body USER_ID is *not* specified, the account will be owned by the logged in User.\n\nNote: The Amount MUST be zero.\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 request body fields:**\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**payment_system**](/glossary#): SEPA\n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**account_attributes**](/glossary#account_attributes): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**payment_system**](/glossary#): SEPA\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[product_instance_code](/glossary#): product_instance_code\n\n\n","example_request_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","payment_system":"SEPA","balance":{"currency":"EUR","amount":"0"},"label":"My Account","branch_id":"DERBY6","account_routings":[{"scheme":"AccountNumber","address":"4930396"}]},"success_response_body":{"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","payment_system":"SEPA","balance":{"currency":"EUR","amount":"0"},"label":"My Account","branch_id":"DERBY6","account_routings":[{"scheme":"AccountNumber","address":"4930396"}],"account_attributes":[{"product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","product_instance_code":"LKJL98769F"}]},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","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-10003: Invalid Currency Value. It should be three letters ISO Currency Code. ","OBP-50000: Unknown Error."],"tags":["Bank"],"typed_request_body":{"type":"object","properties":{"payment_system":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"branch_id":{"type":"string"},"user_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"payment_system":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"branch_id":{"type":"string"},"account_id":{"type":"string"},"user_id":{"type":"string"}}},"roles":[{"role":"CanCreateSettlementAccountAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/settlement-accounts","connector_methods":[]},{"operation_id":"OBPv2.0.0-getTransactionTypes","implemented_by":{"version":"OBPv2.0.0","function":"getTransactionTypes"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/transaction-types","summary":"Get Transaction Types at Bank","description":"Get 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:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\n\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\nvalue: 5987953
\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#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**short_code**](/glossary#short_code): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**transaction_types**](/glossary#transaction_types): \n\n\n\n[**value**](/glossary#): 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"],"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/v5.1.0/banks/BANK_ID/transaction-types","connector_methods":[]},{"operation_id":"OBPv5.0.0-getBank","implemented_by":{"version":"OBPv5.0.0","function":"getBank"},"request_verb":"GET","request_url":"/obp/v5.0.0/banks/BANK_ID","summary":"Get Bank","description":"Get the bank specified by BANK_ID
\nReturns information about a single bank specified by BANK_ID including:
Authentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\nbank_code: CGHZ
\nbank_routings: bank routing in form of (scheme, address)
\nfull_name: full name string
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlogo: logo url
\nname: ACCOUNT_MANAGEMENT_FEE
\nscheme: scheme value
\nvalue: 5987953
\nwebsite: www.openbankproject.com
\nattributes: attribute value in form of (name, value)
\n","description_markdown":"Get the bank specified by BANK_ID\nReturns information about a single bank specified by BANK_ID including:\n\n* Bank code and full name of bank\n* Logo URL\n* Website\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[**address**](/glossary#address): \n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_routings**](/glossary#bank_routings): bank routing in form of (scheme, address)\n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**logo**](/glossary#logo): logo url\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**website**](/glossary#website): www.openbankproject.com\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n","success_response_body":{"id":"gh.29.uk","bank_code":"CGHZ","full_name":"bank fullName string","logo":"bank logoUrl string","website":"bank logoUrl string","bank_routings":[{"scheme":"scheme value","address":""}],"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID."],"tags":["Bank","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"website":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"bank_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"logo":{"type":"string"},"bank_code":{"type":"string"},"full_name":{"type":"string"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getBankAttribute","implemented_by":{"version":"OBPv4.0.0","function":"getBankAttribute"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/attributes/BANK_ATTRIBUTE_ID","summary":"Get Bank Attribute By BANK_ATTRIBUTE_ID","description":"Get Bank Attribute By BANK_ATTRIBUTE_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ATTRIBUTE_ID: BANK_ATTRIBUTE_ID
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_attribute_id: bank_attribute_id
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: true
\n","description_markdown":"Get Bank Attribute By BANK_ATTRIBUTE_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ATTRIBUTE_ID](/glossary#): BANK_ATTRIBUTE_ID\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\n[**bank_attribute_id**](/glossary#): bank_attribute_id\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): true\n\n\n","success_response_body":{"bank_id":"gh.29.uk","bank_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","is_active":true},"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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Bank"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"},"bank_attribute_id":{"type":"string"}}},"roles":[{"role":"CanGetBankAttribute","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attributes/BANK_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-enableDisableAccountWebhook","implemented_by":{"version":"OBPv3.1.0","function":"enableDisableAccountWebhook"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/account-web-hooks","summary":"Enable/Disable an Account Webhook","description":"Enable/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:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\nis_active: true
\n\nurl: http://www.example.com/id-docs/123/image.png
\n","description_markdown":"Enable/Disable an Account Webhook\n\n\nWebhooks are used to call external URLs when certain events happen.\n\nAccount Webhooks focus on events around accounts.\n\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.\n\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange\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[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_webhook_id**](/glossary#account_webhook_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n","example_request_body":{"account_webhook_id":"fc23a7e2-7dd2-4bdf-a0b4-ae31232a4762","is_active":"true"},"success_response_body":{"account_webhook_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","trigger_name":"OnBalanceChange","url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","is_active":true},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Webhook","Bank"],"typed_request_body":{"type":"object","properties":{"account_webhook_id":{"type":"string"},"is_active":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"account_webhook_id":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}},"roles":[{"role":"CanUpdateWebhook","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/account-web-hooks","connector_methods":[]},{"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:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\n\n\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\nvalue: 5987953
\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#): 10.12\n\n\n\n[**bankId**](/glossary#bankid): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**shortCode**](/glossary#shortcode): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**value**](/glossary#): 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/v5.1.0/banks/BANK_ID/transaction-types","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteBankAttribute","implemented_by":{"version":"OBPv4.0.0","function":"deleteBankAttribute"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/attributes/BANK_ATTRIBUTE_ID","summary":"Delete Bank Attribute","description":"Delete Bank Attribute
\nDelete a Bank Attribute by its id.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ATTRIBUTE_ID: BANK_ATTRIBUTE_ID
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete Bank Attribute\n\nDelete a Bank Attribute by its id.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ATTRIBUTE_ID](/glossary#): BANK_ATTRIBUTE_ID\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","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":["Bank"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attributes/BANK_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getBanks","implemented_by":{"version":"OBPv4.0.0","function":"getBanks"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks","summary":"Get Banks","description":"Get banks on this API instance
\nReturns a list of banks supported on this server:
Authentication is Optional
\nJSON response body fields:
\n\nbank_routings: bank routing in form of (scheme, address)
\n\nfull_name: full name string
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlogo: logo url
\nname: ACCOUNT_MANAGEMENT_FEE
\nscheme: scheme value
\n\nvalue: 5987953
\nwebsite: www.openbankproject.com
\nattributes: attribute value in form of (name, value)
\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\n[**address**](/glossary#address): \n\n\n\n[**bank_routings**](/glossary#bank_routings): bank routing in form of (scheme, address)\n\n\n\n[**banks**](/glossary#banks): \n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**logo**](/glossary#logo): logo url\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**website**](/glossary#website): www.openbankproject.com\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n","success_response_body":{"banks":[{"id":"gh.29.uk","short_name":"short_name ","full_name":"full_name","logo":"logo","website":"www.openbankproject.com","bank_routings":[{"scheme":"scheme value","address":""}],"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["BankAccountTag1","Bank","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"banks":{"type":"array","items":{"type":"object","properties":{"website":{"type":"string"},"logo":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"short_name":{"type":"string"},"bank_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"id":{"type":"string"},"full_name":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks","connector_methods":[]},{"operation_id":"OBPv3.0.0-getBranch","implemented_by":{"version":"OBPv3.0.0","function":"getBranch"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/branches/BRANCH_ID","summary":"Get Branch","description":"Returns information about a single Branch specified by BANK_ID and BRANCH_ID including:
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nBRANCH_ID: DERBY6
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\n\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: true
\nlatitude: 38.8951
\n\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\nscheme: scheme value
\n\n\n\n\n\n","description_markdown":"Returns information about a single Branch specified by BANK_ID and BRANCH_ID including:\n\n* Name\n* Address\n* Geo Location\n* License the data under this endpoint is released under.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[BRANCH_ID](/glossary#): DERBY6\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**accessibleFeatures**](/glossary#accessiblefeatures): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_routing**](/glossary#branch_routing): \n\n\n\n[**branch_type**](/glossary#branch_type): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**closing_time**](/glossary#closing_time): 2020-01-27\n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**drive_up**](/glossary#drive_up): \n\n\n\n[**friday**](/glossary#friday): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_accessible**](/glossary#): true\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**lobby**](/glossary#lobby): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**monday**](/glossary#monday): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**opening_time**](/glossary#opening_time): \n\n\n\n[**phone_number**](/glossary#phone_number): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**saturday**](/glossary#saturday): \n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**state**](/glossary#state): \n\n\n\n[**sunday**](/glossary#sunday): \n\n\n\n[**thursday**](/glossary#thursday): \n\n\n\n[**tuesday**](/glossary#tuesday): \n\n\n\n[**wednesday**](/glossary#wednesday): \n\n\n","success_response_body":{"id":"branch-id-123","bank_id":"bank-id-123","name":"Branch by the Lake","address":{"line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"String","state":"Brandenburg","postcode":"13359","country_code":"DE"},"location":{"latitude":10.0,"longitude":10.0},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"lobby":{"monday":[{"opening_time":"10:00","closing_time":"18:00"}],"tuesday":[{"opening_time":"10:00","closing_time":"18:00"}],"wednesday":[{"opening_time":"10:00","closing_time":"18:00"}],"thursday":[{"opening_time":"10:00","closing_time":"18:00"}],"friday":[{"opening_time":"10:00","closing_time":"18:00"}],"saturday":[{"opening_time":"10:00","closing_time":"18:00"}],"sunday":[{"opening_time":"10:00","closing_time":"18:00"}]},"drive_up":{"monday":{"opening_time":"10:00","closing_time":"18:00"},"tuesday":{"opening_time":"10:00","closing_time":"18:00"},"wednesday":{"opening_time":"10:00","closing_time":"18:00"},"thursday":{"opening_time":"10:00","closing_time":"18:00"},"friday":{"opening_time":"10:00","closing_time":"18:00"},"saturday":{"opening_time":"10:00","closing_time":"18:00"},"sunday":{"opening_time":"10:00","closing_time":"18:00"}},"branch_routing":{"scheme":"OBP","address":"123abc"},"is_accessible":"true","accessibleFeatures":"wheelchair, atm usuable by the visually impaired","branch_type":"Full service store","more_info":"short walk to the lake from here","phone_number":"+381631954907"},"error_response_bodies":["OBP-300010: Branch not found. Please specify a valid value for BRANCH_ID. Or License may not be set. meta.license.id and meta.license.name can not be empty","OBP-50000: Unknown Error."],"tags":["Branch","Bank"],"typed_success_response_body":{"type":"object","properties":{"accessibleFeatures":{"type":"string"},"more_info":{"type":"string"},"branch_type":{"type":"string"},"name":{"type":"string"},"bank_id":{"type":"string"},"location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"county":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"}}},"drive_up":{"type":"object","properties":{"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"phone_number":{"type":"string"},"lobby":{"type":"object","properties":{"saturday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"tuesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"monday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"friday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"sunday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"wednesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"thursday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/branches/BRANCH_ID","connector_methods":[]}]}