API Explorer

v3.0.0 (164 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Product

Create or Update Product for the Bank.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

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:

Typical Successful Response:

								
									
{ "bank_id":"gh.29.uk", "code":"prod1", "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" } } }
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.
Version: OBPv2.2.0, function_name: by createProduct, operation_id: OBPv2.2.0-createProduct Tags: Product,

Get Bank Product

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

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

Typical Successful Response:

								
									
{ "bank_id":"bankid123", "code":"prod1", "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: OBPv2.1.0, function_name: by getProduct, operation_id: OBPv2.1.0-getProduct Tags: Product,

Get Bank Products

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

  • Name
  • Code
  • Category
  • Family
  • Super Family
  • More info URL
  • Description
  • Terms and Conditions
  • License the data under this endpoint is released under
    Authentication is Optional

URL Parameters:

BANK_ID: gh.29.uk

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

products:

super_family:

Typical Successful Response:

								
									
{ "products":[{ "bank_id":"bankid123", "code":"prod1", "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-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: OBPv2.1.0, function_name: by getProducts, operation_id: OBPv2.1.0-getProducts Tags: Product,