right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (610 APIs)

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

Create Connector Method

Create an internal connector.

The method_body is URL-encoded format String

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response: 

								
									
{
  "connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51",
  "method_name":"getBank",
  "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29",
  "programming_lang":"Scala"
}
Required Roles:
  • CanCreateConnectorMethod - 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 createConnectorMethod, operation_id: OBPv4.0.0-createConnectorMethod Tags: Connector-Method,

Get Connector Method by Id

Get an internal connector by CONNECTOR_METHOD_ID.

Authentication is Mandatory

URL Parameters:

CONNECTOR_METHOD_ID: ace0352a-9a0f-4bfa-b30b-9003aa467f51

JSON response body fields:

Typical Successful Response: 

								
									
{
  "connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51",
  "method_name":"getBank",
  "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29",
  "programming_lang":"Scala"
}
Required Roles:
  • CanGetConnectorMethod - 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 getConnectorMethod, operation_id: OBPv4.0.0-getConnectorMethod Tags: Connector-Method,

Get all Connector Methods

Get all Connector Methods.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response: 

								
									
{
  "connectors_methods":[{
    "connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51",
    "method_name":"getBank",
    "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29",
    "programming_lang":"Scala"
  }]
}
Required Roles:
  • CanGetAllConnectorMethods - 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 getAllConnectorMethods, operation_id: OBPv4.0.0-getAllConnectorMethods Tags: Connector-Method,

Update Connector Method

Update an internal connector.

The method_body is URL-encoded format String

Authentication is Mandatory

URL Parameters:

CONNECTOR_METHOD_ID: ace0352a-9a0f-4bfa-b30b-9003aa467f51

JSON response body fields:

Typical Successful Response: 

								
									
{
  "connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51",
  "method_name":"getBank",
  "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29",
  "programming_lang":"Scala"
}
Required Roles:
  • CanUpdateConnectorMethod - 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 updateConnectorMethod, operation_id: OBPv4.0.0-updateConnectorMethod Tags: Connector-Method,