API Explorer

v2.1.0 (135 APIs)

Bank
Accounts
Views
Counterparties
Transactions

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:

JSON response body fields:

  • bank_id: gh.29.uk

  • [code](/glossary#Transaction Requests.Transaction Request Refund Reason Code): 125

  • name: ACCOUNT_MANAGEMENT_FEE

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:

JSON response body fields:

  • bank_id: gh.29.uk

  • [code](/glossary#Transaction Requests.Transaction Request Refund Reason Code): 125

  • name: ACCOUNT_MANAGEMENT_FEE

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,