right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (505 APIs)

API Host: https://api3.openbankproject.com
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

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON response body fields:

bank_id: gh.29.uk

description: This an optional field. Maximum length is 2000. It can be any characters here.

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

license:

meta:

more_info_url: www.example.com/abc

name: ACCOUNT_MANAGEMENT_FEE

parent_product_code: 787LOW

product_code: 1234BW

terms_and_conditions_url: www.example.com/xyz

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

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

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON request body fields:

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

is_active: true

JSON response body fields:

bank_id: gh.29.uk

name: ACCOUNT_MANAGEMENT_FEE

product_attribute_id:

product_code: 1234BW

type:

value: 5987953

is_active: true

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

Create Product Fee

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON request body fields:

amount: 10.12

currency: EUR

frequency: DAILY

is_active: true

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

product_fee_id: 696hlAHLFKUHE37469287634

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

currency: EUR

frequency: DAILY

is_active: true

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

product_fee_id: 696hlAHLFKUHE37469287634

type:

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

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

alias:

attribute_definition_id:

bank_id: gh.29.uk

can_be_seen_on_views: true

category:

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_active: true

name: ACCOUNT_MANAGEMENT_FEE

type:

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
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

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

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_ATTRIBUTE_ID:

PRODUCT_CODE: 1234BW

JSON response body fields:

Typical Successful Response:
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

Authentication is Mandatory

URL Parameters:

ATTRIBUTE_DEFINITION_ID:

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:
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.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON response body fields:

Typical Successful Response:
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 Product Fee

Delete one product fee by its id.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

PRODUCT_FEE_ID: 696hlAHLFKUHE37469287634

JSON response body fields:

Typical Successful Response: 

								
									
true
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

Authentication is Optional

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

currency: EUR

description: This an optional field. Maximum length is 2000. It can be any characters here.

frequency: DAILY

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

is_active: true

license:

meta:

more_info: More information about this fee

more_info_url: www.example.com/abc

name: ACCOUNT_MANAGEMENT_FEE

parent_product_code: 787LOW

product_attribute_id:

product_code: 1234BW

terms_and_conditions_url: www.example.com/xyz

type:

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

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

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_attribute_id:

product_code: 1234BW

type:

value: 5987953

is_active: true

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

Get Product Attribute Definition

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

alias:

attribute_definition_id:

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

bank_id: gh.29.uk

can_be_seen_on_views: true

category:

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_active: true

name: ACCOUNT_MANAGEMENT_FEE

type:

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
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 Product Fee

Get one product fee by its id.

Authentication is Optional

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

currency: EUR

frequency: DAILY

is_active: true

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

product_fee_id: 696hlAHLFKUHE37469287634

type:

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

Get Product Fees

Authentication is Optional

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

currency: EUR

frequency: DAILY

is_active: true

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

product_fee_id: 696hlAHLFKUHE37469287634

product_fees: product_fees

type:

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

Authentication is Optional

URL Parameters:

BANK_ID: gh.29.uk

PRODUCT_CODE: 1234BW

JSON response body fields:

bank_id: gh.29.uk

category:

code: 125

description: This an optional field. Maximum length is 2000. It can be any characters here.

details:

family:

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

license:

meta:

more_info_url: www.example.com/abc

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"
        }
      }
    }
  }
}
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?manager=John&count=8

Authentication is Optional

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_id: gh.29.uk

description: This an optional field. Maximum length is 2000. It can be any characters here.

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

license:

meta:

more_info_url: www.example.com/abc

name: ACCOUNT_MANAGEMENT_FEE

parent_product_code: 787LOW

product_code: 1234BW

products:

terms_and_conditions_url: www.example.com/xyz

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

Authentication is Mandatory

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_attribute_id:

product_code: 1234BW

type:

value: 5987953

is_active: true

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
}
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.

Authentication is Mandatory

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

currency: EUR

frequency: DAILY

is_active: true

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

product_code: 1234BW

product_fee_id: 696hlAHLFKUHE37469287634

type:

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