API Explorer

v4.0.0 (319 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Product

Create or Update Product for the Bank.

Typical Super Family values / Asset classes are:

Debt
Equity
FX
Commodity
Derivative

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.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank_id":"gh.29.uk", "code":"product_code", "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":"5", "name":"TESOBE" } }, "product_attributes":[{ "product_code":"saving1", "product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }] }
Required Roles:
  • CanCreateProduct - Please login to request this Role
  • CanCreateProductAtAnyBank - Please login to request this Role
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.
Implemented in OBPv3.1.0 by createProduct

Create Product Attribute

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"

Authentication is Mandatory

Typical Successful Response:

								
									
{ "product_code":"saving1", "product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }
Required Roles:
  • CanCreateProductAttribute - Please login to request this Role
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:
Implemented in OBPv3.1.0 by createProductAttribute

Create or Update Product Attribute Definition

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

Authentication is Mandatory

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 }
Required Roles:
  • CanCreateProductAttributeDefinitionAtOneBank - Please login to request this Role
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:
Implemented in OBPv4.0.0 by createOrUpdateProductAttributeDefinition

Delete Product Attribute

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.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Possible Errors:
  • 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!
Implemented in OBPv3.1.0 by deleteProductAttribute

Delete Product Attribute Definition

Delete Product Attribute Definition by ATTRIBUTE_DEFINITION_ID

Authentication is Mandatory

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanDeleteProductAttributeDefinitionAtOneBank - Please login to request this Role
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:
Implemented in OBPv4.0.0 by deleteProductAttributeDefinition

Delete Product Cascade

Delete a Product Cascade specified by PRODUCT_CODE.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanDeleteProductCascade - Please login to request this Role
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.
Implemented in OBPv4.0.0 by deleteProductCascade

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
  • Category
  • Family
  • Super Family
  • More info URL
  • Description
  • Terms and Conditions
  • License the data under this endpoint is released under

Authentication is Optional

Typical Successful Response:

								
									
{ "bank_id":"gh.29.uk", "code":"product_code", "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":"5", "name":"TESOBE" } }, "product_attributes":[{ "product_code":"saving1", "product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }] }
Possible Errors:
  • OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getProduct

Get Product Attribute

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.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "product_code":"saving1", "product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }
Possible Errors:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Implemented in OBPv3.1.0 by getProductAttribute

Get Product Attribute Definition

Get Product Attribute Definition

Authentication is Mandatory

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 }] }
Required Roles:
  • CanGetProductAttributeDefinitionAtOneBank - Please login to request this Role
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:
Implemented in OBPv4.0.0 by getProductAttributeDefinition

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.

Authentication is Optional

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":"5", "name":"TESOBE" } }, "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":"5", "name":"TESOBE" } }, "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":"5", "name":"TESOBE" } } } } }
Possible Errors:
  • OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getProductTree

Get Products

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

  • Name
  • Code
  • Parent Product Code
  • Category
  • Family
  • Super Family
  • More info 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?manager=John&count=8

Authentication is Optional

Typical Successful Response:

								
									
{ "products":[{ "bank_id":"gh.29.uk", "code":"product_code", "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":"5", "name":"TESOBE" } }, "product_attributes":[{ "product_code":"saving1", "product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }] }] }
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.
Implemented in OBPv3.1.0 by getProducts

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.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "product_code":"saving1", "product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "name":"OVERDRAFT_START_DATE", "type":"DATE_WITH_DAY", "value":"2012-04-23" }
Possible Errors:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Implemented in OBPv3.1.0 by updateProductAttribute