{"resource_docs":[{"operation_id":"OBPv4.0.0-createProductAttribute","implemented_by":{"version":"OBPv4.0.0","function":"createProductAttribute"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/attribute","summary":"Create Product Attribute","description":"
Create Product Attribute
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\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
\nPRODUCT_CODE: 1234BW
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: true
\nJSON response body fields:
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nproduct_code: 1234BW
\ntype:
\nvalue: 5987953
\nis_active: true
\n","description_markdown":"Create Product Attribute\n\n\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.\n\nEach Product Attribute is linked to its Product by PRODUCT_CODE\n\n\n \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[PRODUCT_CODE](/glossary#product_code): 1234BW\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_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**product_attribute_id**](/glossary#product_attribute_id): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\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":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","is_active":true},"success_response_body":{"bank_id":"gh.29.uk","product_code":"1234BW","product_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":["Product"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"}}},"roles":[{"role":"CanCreateProductAttribute","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/products/PRODUCT_CODE/attribute","connector_methods":["obp.getProduct","obp.createOrUpdateProductAttribute","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-getProductFees","implemented_by":{"version":"OBPv4.0.0","function":"getProductFees"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/fees","summary":"Get Product Fees","description":"Get Product Fees
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\nfrequency: DAILY
\nis_active: true
\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\nproduct_fees: product_fees
\ntype:
\nvalue: 5987953
\n","description_markdown":"Get Product Fees\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\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[**currency**](/glossary#): EUR\n\n\n\n[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**is_active**](/glossary#is_active): true\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[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**product_fee_id**](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\n\n\n\n[**product_fees**](/glossary#): product_fees\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"product_fees":[{"bank_id":"gh.29.uk","product_code":"1234BW","product_fee_id":"696hlAHLFKUHE37469287634","name":"ACCOUNT_MANAGEMENT_FEE","is_active":true,"more_info":"More information about this fee","value":{"currency":"EUR","amount":"10.12","frequency":"DAILY","type":""}}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Product"],"typed_success_response_body":{"type":"object","properties":{"product_fees":{"type":"array","items":{"type":"object","properties":{"product_code":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}},"product_fee_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/products/PRODUCT_CODE/fees","connector_methods":["obp.getProductFeesFromProvider","obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-getProductAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"getProductAttributeDefinition"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/product","summary":"Get Product Attribute Definition","description":"Get Product Attribute Definition
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nattributes: attribute value in form of (name, value)
\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":"Get Product Attribute Definition\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[**attributes**](/glossary#attributes): attribute value in form of (name, value)\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","success_response_body":{"attributes":[{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"Product","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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Product"],"typed_success_response_body":{"type":"object","properties":{"attributes":{"type":"array","items":{"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":"CanGetProductAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/attribute-definitions/product","connector_methods":["obp.getAttributeDefinition"]},{"operation_id":"OBPv5.0.0-createProduct","implemented_by":{"version":"OBPv5.0.0","function":"createProduct"},"request_verb":"PUT","request_url":"/obp/v5.0.0/banks/BANK_ID/products/PRODUCT_CODE","summary":"Create Product","description":"Create or Update Product for the Bank.
\nTypical Super Family values / Asset classes are:
\nDebt
\nEquity
\nFX
\nCommodity
\nDerivative
Product hiearchy vs Product Collections:
\nYou can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.
\nYou can define a collection (also known as baskets or buckets) of products using Product Collections.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\nbank_id: gh.29.uk
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_product_code: 787LOW
\nproduct_code: 1234BW
\nterms_and_conditions_url: www.example.com/xyz
\nattributes: attribute value in form of (name, value)
\nfees: fees
\n","description_markdown":"Create or Update Product for the Bank.\n\n\nTypical Super Family values / Asset classes are:\n\nDebt\nEquity\nFX\nCommodity\nDerivative\n\n\n\nProduct hiearchy vs Product Collections:\n\n* You can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.\n\n* You can define a collection (also known as baskets or buckets) of products using Product Collections.\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[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\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[**license**](/glossary#license): \n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**parent_product_code**](/glossary#parent_product_code): 787LOW\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**terms_and_conditions_url**](/glossary#): www.example.com/xyz\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[fees](/glossary#): fees\n\n\n","example_request_body":{"parent_product_code":"787LOW","name":"Deposit Account 1","more_info_url":"www.example.com/abc","terms_and_conditions_url":"www.example.com/xyz","description":"This an optional field. Maximum length is 2000. It can be any characters here.","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}},"success_response_body":{"bank_id":"gh.29.uk","product_code":"1234BW","parent_product_code":"787LOW","name":"Deposit Account 1","more_info_url":"www.example.com/abc","terms_and_conditions_url":"www.example.com/xyz","description":"This an optional field. Maximum length is 2000. It can be any characters here.","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}},"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":["Product"],"typed_request_body":{"type":"object","properties":{"more_info_url":{"type":"string"},"description":{"type":"string"},"terms_and_conditions_url":{"type":"string"},"parent_product_code":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"description":{"type":"string"},"product_code":{"type":"string"},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"more_info_url":{"type":"string"},"parent_product_code":{"type":"string"},"name":{"type":"string"},"terms_and_conditions_url":{"type":"string"}}},"roles":[{"role":"CanCreateProduct","requires_bank_id":true},{"role":"CanCreateProductAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/products/PRODUCT_CODE","connector_methods":["obp.getProduct","obp.createOrUpdateProduct"]},{"operation_id":"OBPv4.0.0-getProducts","implemented_by":{"version":"OBPv4.0.0","function":"getProducts"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/products","summary":"Get Products","description":"Returns information about the financial products offered by a bank specified by BANK_ID including:
\nCan filter with attributes name and values.
\nURL params example: /banks/some-bank-id/products?manager=John&count=8
Authentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_id: gh.29.uk
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_product_code: 787LOW
\nproduct_code: 1234BW
\n\nterms_and_conditions_url: www.example.com/xyz
\nattributes: attribute value in form of (name, value)
\nfees: fees
\n","description_markdown":"Returns information about the financial products offered by a bank specified by BANK_ID including:\n\n* Name\n* Code\n* Parent Product Code\n* More info URL\n* Terms And Conditions URL\n* Description\n* Terms and Conditions\n* License the data under this endpoint is released under\n\nCan filter with attributes name and values.\nURL params example: /banks/some-bank-id/products?manager=John&count=8\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#): gh.29.uk\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[**license**](/glossary#license): \n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**parent_product_code**](/glossary#parent_product_code): 787LOW\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**products**](/glossary#products): \n\n\n\n[**terms_and_conditions_url**](/glossary#): www.example.com/xyz\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[fees](/glossary#): fees\n\n\n","success_response_body":{"products":[{"bank_id":"gh.29.uk","product_code":"1234BW","parent_product_code":"787LOW","name":"Deposit Account 1","more_info_url":"www.example.com/abc","terms_and_conditions_url":"www.example.com/xyz","description":"This an optional field. Maximum length is 2000. It can be any characters here.","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Product"],"typed_success_response_body":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"product_code":{"type":"string"},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"more_info_url":{"type":"string"},"parent_product_code":{"type":"string"},"name":{"type":"string"},"terms_and_conditions_url":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/products","connector_methods":["obp.getProducts","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-getProductCollection","implemented_by":{"version":"OBPv3.1.0","function":"getProductCollection"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/product-collections/COLLECTION_CODE","summary":"Get Product Collection","description":"Returns information about the financial Product Collection specified by BANK_ID and COLLECTION_CODE:
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\ncode: 125
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_product_code: 787LOW
\n\nproduct_code: 1234BW
\n\n\ntype:
\nvalue: 5987953
\n\n","description_markdown":"Returns information about the financial Product Collection specified by BANK_ID and COLLECTION_CODE:\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[COLLECTION_CODE](/glossary#collection_code): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**code**](/glossary#code): 125\n\n\n\n[**collection_code**](/glossary#collection_code): \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[**details**](/glossary#details): \n\n\n\n[**family**](/glossary#family): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**parent_product_code**](/glossary#parent_product_code): 787LOW\n\n\n\n[**product_attribute_id**](/glossary#product_attribute_id): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**products**](/glossary#products): \n\n\n\n[**super_family**](/glossary#super_family): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[product_attributes](/glossary#product_attributes): \n\n\n","success_response_body":{"collection_code":"A","products":[{"bank_id":"gh.29.uk","code":"1234BW","parent_product_code":"parent","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"product_attributes":[{"product_code":"1234BW","product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23"}]}]},"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":["Product-Collection","Product"],"typed_success_response_body":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"parent_product_code":{"type":"string"},"bank_id":{"type":"string"},"code":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"product_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"name":{"type":"string"},"category":{"type":"string"}}}},"collection_code":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/product-collections/COLLECTION_CODE","connector_methods":["obp.getProductCollectionItemsTree","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-getProductAttribute","implemented_by":{"version":"OBPv4.0.0","function":"getProductAttribute"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID","summary":"Get Product Attribute","description":"Get Product Attribute
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\nGet one product attribute by its id.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nproduct_code: 1234BW
\ntype:
\nvalue: 5987953
\nis_active: true
\n","description_markdown":"Get Product Attribute\n\n\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.\n\nEach Product Attribute is linked to its Product by PRODUCT_CODE\n\n\n \n\nGet one product attribute by its id.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_ATTRIBUTE_ID](/glossary#product_attribute_id): \n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**product_attribute_id**](/glossary#product_attribute_id): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\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","product_code":"1234BW","product_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-20006: User is missing one or more roles: ","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Product"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"}}},"roles":[{"role":"CanUpdateProductAttribute","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID","connector_methods":["obp.getProductAttributeById","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-deleteProductCascade","implemented_by":{"version":"OBPv4.0.0","function":"deleteProductCascade"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/cascading/banks/BANK_ID/products/PRODUCT_CODE","summary":"Delete Product Cascade","description":"Delete a Product Cascade specified by PRODUCT_CODE.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\n","description_markdown":"Delete a Product Cascade specified by PRODUCT_CODE.\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[PRODUCT_CODE](/glossary#product_code): 1234BW\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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Product"],"roles":[{"role":"CanDeleteProductCascade","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/management/cascading/banks/BANK_ID/products/PRODUCT_CODE","connector_methods":[]},{"operation_id":"OBPv4.0.0-getProductFee","implemented_by":{"version":"OBPv4.0.0","function":"getProductFee"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/fees/PRODUCT_FEE_ID","summary":"Get Product Fee","description":"Get Product Fee
\nGet one product fee by its id.
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nPRODUCT_FEE_ID: 696hlAHLFKUHE37469287634
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\nfrequency: DAILY
\nis_active: true
\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\ntype:
\nvalue: 5987953
\n","description_markdown":"Get Product Fee\n\nGet one product fee by its id.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n[PRODUCT_FEE_ID](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\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[**currency**](/glossary#): EUR\n\n\n\n[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**is_active**](/glossary#is_active): true\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[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**product_fee_id**](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"bank_id":"gh.29.uk","product_code":"1234BW","product_fee_id":"696hlAHLFKUHE37469287634","name":"ACCOUNT_MANAGEMENT_FEE","is_active":true,"more_info":"More information about this fee","value":{"currency":"EUR","amount":"10.12","frequency":"DAILY","type":""}},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Product"],"typed_success_response_body":{"type":"object","properties":{"product_code":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}},"product_fee_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/products/PRODUCT_CODE/fees/PRODUCT_FEE_ID","connector_methods":["obp.getProductFeeById","obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-createProductFee","implemented_by":{"version":"OBPv4.0.0","function":"createProductFee"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/fee","summary":"Create Product Fee","description":"Create Product Fee
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON request body fields:
\namount: 10.12
\ncurrency: EUR
\nfrequency: DAILY
\nis_active: true
\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\nfrequency: DAILY
\nis_active: true
\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\ntype:
\nvalue: 5987953
\n","description_markdown":"Create Product Fee\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**is_active**](/glossary#is_active): true\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[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[product_fee_id](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\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[**currency**](/glossary#): EUR\n\n\n\n[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**is_active**](/glossary#is_active): true\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[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**product_fee_id**](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"ACCOUNT_MANAGEMENT_FEE","is_active":true,"more_info":"More information about this fee","value":{"currency":"EUR","amount":"10.12","frequency":"DAILY","type":""}},"success_response_body":{"bank_id":"gh.29.uk","product_code":"1234BW","product_fee_id":"696hlAHLFKUHE37469287634","name":"ACCOUNT_MANAGEMENT_FEE","is_active":true,"more_info":"More information about this fee","value":{"currency":"EUR","amount":"10.12","frequency":"DAILY","type":""}},"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":["Product"],"typed_request_body":{"type":"object","properties":{"is_active":{"type":"boolean"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"product_code":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}},"product_fee_id":{"type":"string"}}},"roles":[{"role":"CanCreateProductFee","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/products/PRODUCT_CODE/fee","connector_methods":["obp.createOrUpdateProductFee"]},{"operation_id":"OBPv4.0.0-updateProductFee","implemented_by":{"version":"OBPv4.0.0","function":"updateProductFee"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/fees/PRODUCT_FEE_ID","summary":"Update Product Fee","description":"Update Product Fee.
\nUpdate one Product Fee by its id.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nPRODUCT_FEE_ID: 696hlAHLFKUHE37469287634
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\nfrequency: DAILY
\nis_active: true
\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\ntype:
\nvalue: 5987953
\n","description_markdown":"Update Product Fee. \n\nUpdate one Product Fee by its id.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n[PRODUCT_FEE_ID](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\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[**currency**](/glossary#): EUR\n\n\n\n[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**is_active**](/glossary#is_active): true\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[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**product_fee_id**](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"ACCOUNT_MANAGEMENT_FEE","is_active":true,"more_info":"More information about this fee","value":{"currency":"EUR","amount":"10.12","frequency":"DAILY","type":""}},"success_response_body":{"bank_id":"gh.29.uk","product_code":"1234BW","product_fee_id":"696hlAHLFKUHE37469287634","name":"ACCOUNT_MANAGEMENT_FEE","is_active":true,"more_info":"More information about this fee","value":{"currency":"EUR","amount":"10.12","frequency":"DAILY","type":""}},"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":["Product"],"typed_request_body":{"type":"object","properties":{"is_active":{"type":"boolean"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"product_code":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}},"product_fee_id":{"type":"string"}}},"roles":[{"role":"CanUpdateProductFee","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/products/PRODUCT_CODE/fees/PRODUCT_FEE_ID","connector_methods":["obp.createOrUpdateProductFee","obp.getProductFeeById"]},{"operation_id":"OBPv3.1.0-deleteProductAttribute","implemented_by":{"version":"OBPv3.1.0","function":"deleteProductAttribute"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID","summary":"Delete Product Attribute","description":"Delete Product Attribute
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\nDelete a Product Attribute by its id.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\n","description_markdown":"Delete Product Attribute\n\n\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.\n\nEach Product Attribute is linked to its Product by PRODUCT_CODE\n\n\n \n\nDelete a Product Attribute by its id.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_ATTRIBUTE_ID](/glossary#product_attribute_id): \n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["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.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Product"],"roles":[{"role":"CanUpdateProductAttribute","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID","connector_methods":["obp.deleteProductAttribute","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-getProduct","implemented_by":{"version":"OBPv4.0.0","function":"getProduct"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE","summary":"Get Bank Product","description":"Returns information about a financial Product offered by the bank specified by BANK_ID and PRODUCT_CODE including:
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nfrequency: DAILY
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_active: true
\n\nmeta:
\nmore_info: More information about this fee
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_product_code: 787LOW
\n\nproduct_code: 1234BW
\nterms_and_conditions_url: www.example.com/xyz
\ntype:
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nfees: fees
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\n","description_markdown":"Returns information about a financial Product offered by the bank specified by BANK_ID and PRODUCT_CODE including:\n\n* Name\n* Code\n* Parent Product Code\n* More info URL\n* Description\n* Terms and Conditions\n* Description\n* Meta\n* Attributes\n* Fees\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\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[**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[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**parent_product_code**](/glossary#parent_product_code): 787LOW\n\n\n\n[**product_attribute_id**](/glossary#product_attribute_id): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**terms_and_conditions_url**](/glossary#): www.example.com/xyz\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[fees](/glossary#): fees\n\n\n\n[product_fee_id](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\n\n\n","success_response_body":{"bank_id":"gh.29.uk","product_code":"1234BW","parent_product_code":"787LOW","name":"Deposit Account 1","more_info_url":"www.example.com/abc","terms_and_conditions_url":"www.example.com/xyz","description":"This an optional field. Maximum length is 2000. It can be any characters here.","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"attributes":[{"product_code":"1234BW","product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23"}],"fees":[{"product_fee_id":"696hlAHLFKUHE37469287634","name":"ACCOUNT_MANAGEMENT_FEE","is_active":true,"more_info":"More information about this fee","value":{"currency":"EUR","amount":"10.12","frequency":"DAILY","type":""}}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.","OBP-50000: Unknown Error."],"tags":["Product"],"typed_success_response_body":{"type":"object","properties":{"description":{"type":"string"},"product_code":{"type":"string"},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"more_info_url":{"type":"string"},"parent_product_code":{"type":"string"},"name":{"type":"string"},"terms_and_conditions_url":{"type":"string"},"fees":{"type":"array","items":{"type":"object","properties":{"is_active":{"type":"boolean"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}},"product_fee_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/products/PRODUCT_CODE","connector_methods":["obp.getProduct","obp.getProductFeesFromProvider","obp.getProductAttributesByBankAndCode","obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-updateProductAttribute","implemented_by":{"version":"OBPv4.0.0","function":"updateProductAttribute"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID","summary":"Update Product Attribute","description":"Update Product Attribute.
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\nUpdate one Product Attribute by its id.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nproduct_code: 1234BW
\ntype:
\nvalue: 5987953
\nis_active: true
\n","description_markdown":"Update Product Attribute. \n\n\n\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.\n\nEach Product Attribute is linked to its Product by PRODUCT_CODE\n\n\n \n\nUpdate one Product Attribute by its id.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_ATTRIBUTE_ID](/glossary#product_attribute_id): \n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**product_attribute_id**](/glossary#product_attribute_id): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\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":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","is_active":true},"success_response_body":{"bank_id":"gh.29.uk","product_code":"1234BW","product_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-20006: User is missing one or more roles: ","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Product"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"}}},"roles":[{"role":"CanUpdateProductAttribute","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID","connector_methods":["obp.createOrUpdateProductAttribute","obp.getProductAttributeById","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-deleteProductFee","implemented_by":{"version":"OBPv4.0.0","function":"deleteProductFee"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/fees/PRODUCT_FEE_ID","summary":"Delete Product Fee","description":"Delete Product Fee
\nDelete one product fee by its id.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nPRODUCT_FEE_ID: 696hlAHLFKUHE37469287634
\nJSON response body fields:
\n","description_markdown":"Delete Product Fee\n\nDelete one product fee by its id.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n[PRODUCT_FEE_ID](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":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-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Product"],"roles":[{"role":"CanDeleteProductFee","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/products/PRODUCT_CODE/fees/PRODUCT_FEE_ID","connector_methods":["obp.deleteProductFee","obp.getProductFeeById"]},{"operation_id":"OBPv4.0.0-createOrUpdateProductAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"createOrUpdateProductAttributeDefinition"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/product","summary":"Create or Update Product Attribute Definition","description":"Create or Update Product Attribute Definition
\nThe category field must be Product
\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 Product Attribute Definition\n\nThe category field must be Product\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":"Product","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":"Product","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":["Product"],"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":"CanCreateProductAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/attribute-definitions/product","connector_methods":["obp.createOrUpdateAttributeDefinition"]},{"operation_id":"OBPv3.1.0-getProductTree","implemented_by":{"version":"OBPv3.1.0","function":"getProductTree"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/product-tree/PRODUCT_CODE","summary":"Get Product Tree","description":"Returns information about a particular financial product specified by BANK_ID and PRODUCT_CODE
\nand it's parent product(s) recursively as specified by parent_product_code.
Each product includes the following information.
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\ncode: 125
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n","description_markdown":"Returns information about a particular financial product specified by BANK_ID and PRODUCT_CODE\nand it's parent product(s) recursively as specified by parent_product_code.\n\nEach product includes the following information.\n\n* Name\n* Code\n* Parent Product Code\n* Category\n* Family\n* Super Family\n* More info URL\n* Description\n* Terms and Conditions\n* License: The licence under which this product data is released. Licence can be an Open Data licence such as Open Data Commons Public Domain Dedication and License (PDDL) or Copyright etc.\n\n\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**code**](/glossary#code): 125\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[**details**](/glossary#details): \n\n\n\n[**family**](/glossary#family): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**super_family**](/glossary#super_family): \n\n\n\n[parent_product](/glossary#parent_product): \n\n\n","success_response_body":{"bank_id":"testBank2","code":"PRODUCT_CODE","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"parent_product":{"bank_id":"testBank2","code":"PARENT_CODE","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"parent_product":{"bank_id":"testBank2","code":"GRANDPARENT_CODE","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}}}},"error_response_bodies":["OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.","OBP-50000: Unknown Error."],"tags":["Product"],"typed_success_response_body":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"code":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"bank_id":{"type":"string"},"parent_product":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"parent_product":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"code":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"}}},"code":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"}}},"name":{"type":"string"},"category":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/product-tree/PRODUCT_CODE","connector_methods":["obp.getProduct","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-createProductCollection","implemented_by":{"version":"OBPv3.1.0","function":"createProductCollection"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/product-collections/COLLECTION_CODE","summary":"Create Product Collection","description":"Create or Update a Product Collection at the Bank.
\nUse Product Collections to create Product "Baskets", "Portfolios", "Indices", "Collections", "Underlyings-lists", "Buckets" etc. etc.
\nThere is a many to many relationship between Products and Product Collections:
\nA Product can exist in many Collections
\nA Collection can contain many Products.
\nA collection has collection code, one parent Product and one or more child Products.
\nProduct hiearchy vs Product Collections:
\nYou can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.
\nYou can define a collection (also known as baskets or buckets) of products using Product Collections.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\n\n\n\nproduct_code: 1234BW
\n\n","description_markdown":"Create or Update a Product Collection at the Bank.\n\nUse Product Collections to create Product \"Baskets\", \"Portfolios\", \"Indices\", \"Collections\", \"Underlyings-lists\", \"Buckets\" etc. etc.\n\nThere is a many to many relationship between Products and Product Collections:\n\n* A Product can exist in many Collections\n\n* A Collection can contain many Products.\n\nA collection has collection code, one parent Product and one or more child Products.\n\n\n\n\nProduct hiearchy vs Product Collections:\n\n* You can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.\n\n* You can define a collection (also known as baskets or buckets) of products using Product Collections.\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[COLLECTION_CODE](/glossary#collection_code): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**collection_code**](/glossary#collection_code): \n\n\n\n[**items**](/glossary#items): \n\n\n\n[**member_product_code**](/glossary#member_product_code): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**product_collection**](/glossary#product_collection): \n\n\n","example_request_body":{"parent_product_code":"A","children_product_codes":["B","C","D"]},"success_response_body":{"product_collection":[{"collection_code":"C","product_code":"1234BW","items":[{"member_product_code":"A"},{"member_product_code":"B"}]}]},"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":["Product-Collection","Product"],"typed_request_body":{"type":"object","properties":{"parent_product_code":{"type":"string"},"children_product_codes":{"type":"array","items":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"product_collection":{"type":"array","items":{"type":"object","properties":{"collection_code":{"type":"string"},"product_code":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"member_product_code":{"type":"string"}}}}}}}}},"roles":[{"role":"CanMaintainProductCollection","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/product-collections/COLLECTION_CODE","connector_methods":["obp.getProducts","obp.getOrCreateProductCollectionItem","obp.getOrCreateProductCollection","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-deleteProductAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"deleteProductAttributeDefinition"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/product","summary":"Delete Product Attribute Definition","description":"Delete Product Attribute Definition by ATTRIBUTE_DEFINITION_ID
\nAuthentication is Mandatory
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete Product Attribute Definition by ATTRIBUTE_DEFINITION_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ATTRIBUTE_DEFINITION_ID](/glossary#attribute_definition_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-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":["Product"],"roles":[{"role":"CanDeleteProductAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/product","connector_methods":["obp.deleteAttributeDefinition"]}]}