API Explorer

Bank
Accounts
Views
Counterparties
Transactions

Create new OBP API

Create new OBP API.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"OBP_API"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									
{ "bank-id":"gh.29.uk", "obp_api":{ "oBP_APIId":"429ba7c3-b356-4335-8534-6265b9a32e4b", "name":"Reena Aheer", "number":45869231 } }
Required Roles:
  • CanCreateDynamicEntity_OBP_API - 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-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_createOBP_API, operation_id: OBPv4.0.0-dynamicEntity_createOBP_API Tags: _OBP API, New-Style, Dynamic-Entity, Dynamic,

Delete OBP API by id

Delete OBP API by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"OBP_API"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									
{ "bank-id":"gh.29.uk", "obp_api":{ "oBP_APIId":"c3931261-dd75-4de3-95e6-0df50d7d29ad", "name":"Reena Aheer", "number":45869231 } }
Required Roles:
  • CanDeleteDynamicEntity_OBP_API - 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-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteOBP_API, operation_id: OBPv4.0.0-dynamicEntity_deleteOBP_API Tags: _OBP API, New-Style, Dynamic-Entity, Dynamic,

Get OBP API List

Get OBP API List.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"OBP_API"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /OBP_API?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response

								
									
{ "bank-id":"gh.29.uk", "obp_api_list":[{ "bank-id":"gh.29.uk", "obp_api":{ "oBP_APIId":"65e2645a-4800-44a9-b0e0-ba34e966f2cc", "name":"Reena Aheer", "number":45869231 } }] }
Required Roles:
  • CanGetDynamicEntity_OBP_API - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getOBP_APIList, operation_id: OBPv4.0.0-dynamicEntity_getOBP_APIList Tags: _OBP API, New-Style, Dynamic-Entity, Dynamic,

Get OBP API by id

Get OBP API by id.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"OBP_API"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									
{ "bank-id":"gh.29.uk", "obp_api":{ "oBP_APIId":"579231ad-d997-4ef5-af16-96f921b670a5", "name":"Reena Aheer", "number":45869231 } }
Required Roles:
  • CanGetDynamicEntity_OBP_API - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleOBP_API, operation_id: OBPv4.0.0-dynamicEntity_getSingleOBP_API Tags: _OBP API, New-Style, Dynamic-Entity, Dynamic,

Update OBP API

Update OBP API.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"OBP_API"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									
{ "bank-id":"gh.29.uk", "obp_api":{ "oBP_APIId":"ed2b36d7-4a7c-42fb-97f5-18924bce925d", "name":"Reena Aheer", "number":45869231 } }
Required Roles:
  • CanUpdateDynamicEntity_OBP_API - 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-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_updateOBP_API, operation_id: OBPv4.0.0-dynamicEntity_updateOBP_API Tags: _OBP API, New-Style, Dynamic-Entity, Dynamic,