right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (646 APIs)

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

Create new Sustrans

Create new Sustrans.

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":"sustrans"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Typical Successful Response: 

								
									
{
  "sustrans":{
    "sustransId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanCreateDynamicEntity_Systemsustrans - 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_createsustrans_, operation_id: OBPv4.0.0-dynamicEntity_createsustrans_ Tags: _Sustrans, Dynamic-Entity, Dynamic,

Delete Sustrans by id

Delete Sustrans 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":"sustrans"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Typical Successful Response: 

								
									
{
  "sustrans":{
    "sustransId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanDeleteDynamicEntity_Systemsustrans - 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_deletesustrans_, operation_id: OBPv4.0.0-dynamicEntity_deletesustrans_ Tags: _Sustrans, Dynamic-Entity, Dynamic,

Get Sustrans List

Get Sustrans 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":"sustrans"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /sustrans?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: 

								
									
{
  "sustrans_list":[{
    "sustrans":{
      "sustransId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "name":"James Brown",
      "number":698761728
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_Systemsustrans - 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_getsustransList_, operation_id: OBPv4.0.0-dynamicEntity_getsustransList_ Tags: _Sustrans, Dynamic-Entity, Dynamic,

Get Sustrans by id

Get Sustrans 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":"sustrans"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Typical Successful Response: 

								
									
{
  "sustrans":{
    "sustransId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanGetDynamicEntity_Systemsustrans - 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_getSinglesustrans_, operation_id: OBPv4.0.0-dynamicEntity_getSinglesustrans_ Tags: _Sustrans, Dynamic-Entity, Dynamic,

Update Sustrans

Update Sustrans.

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":"sustrans"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Typical Successful Response: 

								
									
{
  "sustrans":{
    "sustransId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanUpdateDynamicEntity_Systemsustrans - 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_updatesustrans_, operation_id: OBPv4.0.0-dynamicEntity_updatesustrans_ Tags: _Sustrans, Dynamic-Entity, Dynamic,