right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (267 APIs)

API Host: https://api3.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

创建产品
映射（类型->字符串）
Typical Successful Response: 

								
									
{
  "bank_id":"GENODEM1GLS",
  "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
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 createProduct, operation_id: OBPv3.1.0-createProduct Tags: Product,

创建产品属性

创建产品属性

产品属性用于描述带有类型化键值对列表的金融产品。

每个产品属性均通过PRODUCT_CODE链接到其产品

典型的产品属性可能是：

ISIN（用于国际债券）
VKN（用于德国债券）
REDCODE（信用衍生产品的Markit短代码）
LOAN_ID（例如用于Anacredit报告）

发行日期（债券在市场上发行时）
MATURITY_DATE（产品寿命终止）
可交易的

有关更多示例，请参见FPML 。

类型字段必须是“ STRING”，“ INTEGER”，“ DOUBLE”或DATE_WITH_DAY”之一

身份验证是强制性的

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
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createProductAttribute, operation_id: OBPv3.1.0-createProductAttribute Tags: Product, New-Style,

删除产品属性

删除产品属性

产品属性用于描述带有类型化键值对列表的金融产品。

每个产品属性均通过PRODUCT_CODE链接到其产品

按ID删除产品属性。

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "jsonString":"{}"
}
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.
Connector Methods:
Version: OBPv3.1.0, function_name: by deleteProductAttribute, operation_id: OBPv3.1.0-deleteProductAttribute Tags: Product, New-Style,

更新产品属性

更新产品属性。

产品属性用于描述带有类型化键值对列表的金融产品。

每个产品属性均通过PRODUCT_CODE链接到其产品

通过其ID更新一个产品属性。

身份验证是强制性的

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"
}
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.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateProductAttribute, operation_id: OBPv3.1.0-updateProductAttribute Tags: Product, New-Style,

获取产品
映射（类型->字符串）
Typical Successful Response: 

								
									
{
  "products":[{
    "bank_id":"GENODEM1GLS",
    "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"
    }]
  }]
}
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-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 getProducts, operation_id: OBPv3.1.0-getProducts Tags: Product,

获取产品属性

获取产品属性

产品属性用于描述带有类型化键值对列表的金融产品。

每个产品属性均通过PRODUCT_CODE链接到其产品

通过其ID获得一个产品属性。

身份验证是强制性的

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"
}
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.
Connector Methods:
Version: OBPv3.1.0, function_name: by getProductAttribute, operation_id: OBPv3.1.0-getProductAttribute Tags: Product, New-Style,

获取产品树
映射（类型->字符串）
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"
        }
      }
    }
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • 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,

获取银行产品
映射（类型->字符串）
Typical Successful Response: 

								
									
{
  "bank_id":"GENODEM1GLS",
  "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"
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • 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 getProduct, operation_id: OBPv3.1.0-getProduct Tags: Product,