API Explorer

name: ACCOUNT_MANAGEMENT_FEE

terms_and_conditions_url: www.example.com/xyz

product_code: 1234BW

attributes: attribute value in form of (name, value)

fees: fees

Typical Successful Response:

								
									{
  "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":"Description of the object. Maximum length is 2000. It can be any characters here.",
  "meta":{
    "license":{
      "id":"ODbL-1.0",
      "name":"Open Database License"
    }
  }
}

Request Headers:

Response Headers:

Required Roles:

CanCreateProduct - Please login to request this Role
CanCreateProductAtAnyBank - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv5.0.0, function_name: by createProduct, operation_id: OBPv5.0.0-createProduct Tags: Product,

Create Product Attribute

Product Attributes are used to describe a financial Product with a list of typed key value pairs.

Each Product Attribute is linked to its Product by PRODUCT_CODE

Typical product attributes might be:

ISIN (for International bonds)
VKN (for German bonds)
REDCODE (markit short code for credit derivative)
LOAN_ID (e.g. used for Anacredit reporting)

ISSUE_DATE (When the bond was issued in the market)
MATURITY_DATE (End of life time of a product)
TRADABLE

See FPML for more examples.

The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON request body fields:

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

is_active: false

JSON response body fields:

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

value: 5987953

is_active: false

Typical Successful Response:

								
									{
  "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
}

Request Headers:

Response Headers:

Required Roles:

CanCreateProductAttribute - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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:

Connector Methods:

Version: OBPv4.0.0, function_name: by createProductAttribute, operation_id: OBPv4.0.0-createProductAttribute Tags: Product,

Create Product Fee

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON request body fields:

amount: 10.12

frequency: DAILY

is_active: false

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

product_fee_id: 696hlAHLFKUHE37469287634

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

frequency: DAILY

is_active: false

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

product_fee_id: 696hlAHLFKUHE37469287634

attribute_definition_id:

value: 5987953

Typical Successful Response:

								
									{
  "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":""
  }
}

Request Headers:

Response Headers:

Required Roles:

CanCreateProductFee - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-10001: Incorrect json format.
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv4.0.0, function_name: by createProductFee, operation_id: OBPv4.0.0-createProductFee Tags: Product,

Create or Update Product Attribute Definition

The category field must be Product

The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

alias:

bank_id: gh.29.uk

can_be_seen_on_views: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_active: false

name: ACCOUNT_MANAGEMENT_FEE

Typical Successful Response:

								
									{
  "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
}

Request Headers:

Response Headers:

Required Roles:

CanCreateProductAttributeDefinitionAtOneBank - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-10001: Incorrect json format.
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv4.0.0, function_name: by createOrUpdateProductAttributeDefinition, operation_id: OBPv4.0.0-createOrUpdateProductAttributeDefinition Tags: Product,

Delete Product Attribute

Product Attributes are used to describe a financial Product with a list of typed key value pairs.

Each Product Attribute is linked to its Product by PRODUCT_CODE

Delete a Product Attribute by its id.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_ATTRIBUTE_ID:

PRODUCT_CODE: 1234BW

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

Required Roles:

CanUpdateProductAttribute - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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!

Connector Methods:

Version: OBPv3.1.0, function_name: by deleteProductAttribute, operation_id: OBPv3.1.0-deleteProductAttribute Tags: Product,

Delete Product Attribute Definition

Delete Product Attribute Definition by ATTRIBUTE_DEFINITION_ID

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATTRIBUTE_DEFINITION_ID:

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

Required Roles:

CanDeleteProductAttributeDefinitionAtOneBank - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv4.0.0, function_name: by deleteProductAttributeDefinition, operation_id: OBPv4.0.0-deleteProductAttributeDefinition Tags: Product,

Delete Product Cascade

Delete a Product Cascade specified by PRODUCT_CODE.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON response body fields:

Typical Successful Response:

Request Headers:

Response Headers:

Required Roles:

CanDeleteProductCascade - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by deleteProductCascade, operation_id: OBPv4.0.0-deleteProductCascade Tags: Product,

Delete Product Fee

Delete one product fee by its id.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

PRODUCT_FEE_ID: 696hlAHLFKUHE37469287634

JSON response body fields:

Typical Successful Response:

								
									true

Request Headers:

Response Headers:

Required Roles:

CanDeleteProductFee - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by deleteProductFee, operation_id: OBPv4.0.0-deleteProductFee Tags: Product,

Get Bank Product

Returns information about a financial Product offered by the bank specified by BANK_ID and PRODUCT_CODE including:

Name
Code
Parent Product Code
More info URL
Description
Terms and Conditions
Description
Meta
Attributes
Fees

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

description: Description of the object. Maximum length is 2000. It can be any characters here.

frequency: DAILY

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_active: false

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

terms_and_conditions_url: www.example.com/xyz

product_code: 1234BW

value: 5987953

attributes: attribute value in form of (name, value)

fees: fees

product_fee_id: 696hlAHLFKUHE37469287634

Typical Successful Response:

								
									{
  "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":"Description of the object. 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":""
    }
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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.

Connector Methods:

Version: OBPv4.0.0, function_name: by getProduct, operation_id: OBPv4.0.0-getProduct Tags: Product,

Get Product Attribute

Product Attributes are used to describe a financial Product with a list of typed key value pairs.

Each Product Attribute is linked to its Product by PRODUCT_CODE

Get one product attribute by its id.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_ATTRIBUTE_ID:

PRODUCT_CODE: 1234BW

JSON response body fields:

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

attribute_definition_id:

value: 5987953

is_active: false

Typical Successful Response:

								
									{
  "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
}

Request Headers:

Response Headers:

Required Roles:

CanUpdateProductAttribute - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.
OBP-20001: User not logged in. Authentication is required!

Connector Methods:

Version: OBPv4.0.0, function_name: by getProductAttribute, operation_id: OBPv4.0.0-getProductAttribute Tags: Product,

Get Product Attribute Definition

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

alias:

attributes: attribute value in form of (name, value)

bank_id: gh.29.uk

can_be_seen_on_views: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_active: false

name: ACCOUNT_MANAGEMENT_FEE

Typical Successful Response:

								
									{
  "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
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetProductAttributeDefinitionAtOneBank - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv4.0.0, function_name: by getProductAttributeDefinition, operation_id: OBPv4.0.0-getProductAttributeDefinition Tags: Product,

Get Product Fee

Get one product fee by its id.

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

PRODUCT_FEE_ID: 696hlAHLFKUHE37469287634

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

frequency: DAILY

is_active: false

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

product_fee_id: 696hlAHLFKUHE37469287634

value: 5987953

Typical Successful Response:

								
									{
  "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":""
  }
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getProductFee, operation_id: OBPv4.0.0-getProductFee Tags: Product,

Get Product Fees

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

frequency: DAILY

is_active: false

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

product_fee_id: 696hlAHLFKUHE37469287634

product_fees: product_fees

value: 5987953

Typical Successful Response:

								
									{
  "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":""
    }
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getProductFees, operation_id: OBPv4.0.0-getProductFees Tags: Product,

Get Product Tree

Returns information about a particular financial product specified by BANK_ID and PRODUCT_CODE
and it's parent product(s) recursively as specified by parent_product_code.

Each product includes the following information.

Name
Code
Parent Product Code
Category
Family
Super Family
More info URL
Description
Terms and Conditions
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.

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON response body fields:

bank_id: gh.29.uk

code: 125

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

family:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

name: ACCOUNT_MANAGEMENT_FEE

super_family:

parent_product:

Typical Successful Response:

								
									{
  "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"
        }
      }
    }
  }
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.1.0, function_name: by getProductTree, operation_id: OBPv3.1.0-getProductTree Tags: Product,

Get Products

Returns information about the financial products offered by a bank specified by BANK_ID including:

Name
Code
Parent Product Code
More info URL
Terms And Conditions URL
Description
Terms and Conditions
License the data under this endpoint is released under

Can filter with attributes name and values.
URL params example: /banks/some-bank-id/products?&limit=50&offset=1

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_id: gh.29.uk

description: Description of the object. Maximum length is 2000. It can be any characters here.

id: d8839721-ad8f-45dd-9f78-2080414b93f9

name: ACCOUNT_MANAGEMENT_FEE

terms_and_conditions_url: www.example.com/xyz

product_code: 1234BW

products:

attributes: attribute value in form of (name, value)

fees: fees

Typical Successful Response:

								
									{
  "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":"Description of the object. Maximum length is 2000. It can be any characters here.",
    "meta":{
      "license":{
        "id":"ODbL-1.0",
        "name":"Open Database License"
      }
    }
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by getProducts, operation_id: OBPv4.0.0-getProducts Tags: Product,

Update Product Attribute

Update Product Attribute.

Product Attributes are used to describe a financial Product with a list of typed key value pairs.

Each Product Attribute is linked to its Product by PRODUCT_CODE

Update one Product Attribute by its id.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_ATTRIBUTE_ID:

PRODUCT_CODE: 1234BW

JSON response body fields:

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

value: 5987953

is_active: false

Typical Successful Response:

								
									{
  "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
}

Request Headers:

Response Headers:

Required Roles:

CanUpdateProductAttribute - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.
OBP-20001: User not logged in. Authentication is required!

Connector Methods:

Version: OBPv4.0.0, function_name: by updateProductAttribute, operation_id: OBPv4.0.0-updateProductAttribute Tags: Product,

Update Product Fee

Update Product Fee.

Update one Product Fee by its id.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

PRODUCT_FEE_ID: 696hlAHLFKUHE37469287634

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

frequency: DAILY

is_active: false

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

product_fee_id: 696hlAHLFKUHE37469287634

value: 5987953

Typical Successful Response:

								
									{
  "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":""
  }
}

Request Headers:

Response Headers:

Required Roles:

CanUpdateProductFee - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by updateProductFee, operation_id: OBPv4.0.0-updateProductFee Tags: Product,

Create Product Collection

Create or Update a Product Collection at the Bank.

Use Product Collections to create Product "Baskets", "Portfolios", "Indices", "Collections", "Underlyings-lists", "Buckets" etc. etc.

There is a many to many relationship between Products and Product Collections:

A Product can exist in many Collections
A Collection can contain many Products.

A collection has collection code, one parent Product and one or more child Products.

Product hiearchy vs Product Collections:

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.
You can define a collection (also known as baskets or buckets) of products using Product Collections.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

COLLECTION_CODE:

JSON response body fields:

collection_code:

items:

member_product_code:

product_code: 1234BW

product_collection:

Typical Successful Response:

								
									{
  "product_collection":[{
    "collection_code":"C",
    "product_code":"1234BW",
    "items":[{
      "member_product_code":"A"
    },{
      "member_product_code":"B"
    }]
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanMaintainProductCollection - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.1.0, function_name: by createProductCollection, operation_id: OBPv3.1.0-createProductCollection Tags: Product-Collection, Product,

Get Product Collection

Returns information about the financial Product Collection specified by BANK_ID and COLLECTION_CODE:

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

COLLECTION_CODE:

JSON response body fields:

bank_id: gh.29.uk

code: 125

collection_code:

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

family:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

name: ACCOUNT_MANAGEMENT_FEE