right logo image
right logo image
Log on
⯆

API Explorer

Log off

v1 (627 APIs)

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

Create Bank Level Dynamic Message Doc

Create a Bank Level Dynamic Message Doc.

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

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

process: obp.getBank

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Typical Successful Response: 

								
									
{
  "outbound_avro_schema":"",
  "inbound_avro_schema":"",
  "adapter_implementation":"",
  "dynamic_message_doc_id":"",
  "description":"Description of the object. Maximum length is 2000. It can be any characters here.",
  "process":"obp.getBank",
  "outbound_topic":"",
  "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",
  "message_format":"",
  "example_outbound_message":{
    
  },
  "inbound_topic":"",
  "example_inbound_message":{
    
  },
  "bank_id":"gh.29.uk",
  "programming_lang":"Scala"
}
Required Roles:
  • CanCreateBankLevelDynamicMessageDoc - Please login to request this Role
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-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 createBankLevelDynamicMessageDoc, operation_id: OBPv4.0.0-createBankLevelDynamicMessageDoc Tags: Dynamic-Message-Doc,

Create Dynamic Message Doc

Create a Dynamic Message Doc.

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

JSON request body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

process: obp.getBank

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Typical Successful Response: 

								
									
{
  "outbound_avro_schema":"",
  "inbound_avro_schema":"",
  "adapter_implementation":"",
  "dynamic_message_doc_id":"",
  "description":"Description of the object. Maximum length is 2000. It can be any characters here.",
  "process":"obp.getBank",
  "outbound_topic":"",
  "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",
  "message_format":"",
  "example_outbound_message":{
    
  },
  "inbound_topic":"",
  "example_inbound_message":{
    
  },
  "bank_id":"gh.29.uk",
  "programming_lang":"Scala"
}
Required Roles:
  • CanCreateDynamicMessageDoc - 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 createDynamicMessageDoc, operation_id: OBPv4.0.0-createDynamicMessageDoc Tags: Dynamic-Message-Doc,

Delete Bank Level Dynamic Message Doc

Delete a Bank Level Dynamic Message Doc.

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

URL Parameters:

BANK_ID: gh.29.uk

DYNAMIC_MESSAGE_DOC_ID:

JSON response body fields:

Typical Successful Response: 

								
									
true
Required Roles:
  • CanDeleteBankLevelDynamicMessageDoc - Please login to request this Role
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-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 deleteBankLevelDynamicMessageDoc, operation_id: OBPv4.0.0-deleteBankLevelDynamicMessageDoc Tags: Dynamic-Message-Doc,

Delete Dynamic Message Doc

Delete a Dynamic Message Doc.

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

URL Parameters:

DYNAMIC_MESSAGE_DOC_ID:

JSON response body fields:

Typical Successful Response: 

								
									
true
Required Roles:
  • CanDeleteDynamicMessageDoc - 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 deleteDynamicMessageDoc, operation_id: OBPv4.0.0-deleteDynamicMessageDoc Tags: Dynamic-Message-Doc,

Get Bank Level Dynamic Message Doc

Get a Bank Level Dynamic Message Doc by DYNAMIC_MESSAGE_DOC_ID.

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

URL Parameters:

BANK_ID: gh.29.uk

DYNAMIC_MESSAGE_DOC_ID:

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Typical Successful Response: 

								
									
{
  "outbound_avro_schema":"",
  "inbound_avro_schema":"",
  "adapter_implementation":"",
  "dynamic_message_doc_id":"",
  "description":"Description of the object. Maximum length is 2000. It can be any characters here.",
  "process":"obp.getBank",
  "outbound_topic":"",
  "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",
  "message_format":"",
  "example_outbound_message":{
    
  },
  "inbound_topic":"",
  "example_inbound_message":{
    
  },
  "bank_id":"gh.29.uk",
  "programming_lang":"Scala"
}
Required Roles:
  • CanGetBankLevelDynamicMessageDoc - Please login to request this Role
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-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 getBankLevelDynamicMessageDoc, operation_id: OBPv4.0.0-getBankLevelDynamicMessageDoc Tags: Dynamic-Message-Doc,

Get Dynamic Message Doc

Get a Dynamic Message Doc by DYNAMIC_MESSAGE_DOC_ID.

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

URL Parameters:

DYNAMIC_MESSAGE_DOC_ID:

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Typical Successful Response: 

								
									
{
  "outbound_avro_schema":"",
  "inbound_avro_schema":"",
  "adapter_implementation":"",
  "dynamic_message_doc_id":"",
  "description":"Description of the object. Maximum length is 2000. It can be any characters here.",
  "process":"obp.getBank",
  "outbound_topic":"",
  "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",
  "message_format":"",
  "example_outbound_message":{
    
  },
  "inbound_topic":"",
  "example_inbound_message":{
    
  },
  "bank_id":"gh.29.uk",
  "programming_lang":"Scala"
}
Required Roles:
  • CanGetDynamicMessageDoc - 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 getDynamicMessageDoc, operation_id: OBPv4.0.0-getDynamicMessageDoc Tags: Dynamic-Message-Doc,

Get all Bank Level Dynamic Message Docs

Get all Bank Level Dynamic Message Docs.

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Typical Successful Response: 

								
									
{
  "dynamic-message-docs":[{
    "outbound_avro_schema":"",
    "inbound_avro_schema":"",
    "adapter_implementation":"",
    "dynamic_message_doc_id":"",
    "description":"Description of the object. Maximum length is 2000. It can be any characters here.",
    "process":"obp.getBank",
    "outbound_topic":"",
    "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",
    "message_format":"",
    "example_outbound_message":{
      
    },
    "inbound_topic":"",
    "example_inbound_message":{
      
    },
    "bank_id":"gh.29.uk",
    "programming_lang":"Scala"
  }]
}
Required Roles:
  • CanGetAllDynamicMessageDocs - Please login to request this Role
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-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 getAllBankLevelDynamicMessageDocs, operation_id: OBPv4.0.0-getAllBankLevelDynamicMessageDocs Tags: Dynamic-Message-Doc,

Get all Dynamic Message Docs

Get all Dynamic Message Docs.

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

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Typical Successful Response: 

								
									
{
  "dynamic-message-docs":[{
    "outbound_avro_schema":"",
    "inbound_avro_schema":"",
    "adapter_implementation":"",
    "dynamic_message_doc_id":"",
    "description":"Description of the object. Maximum length is 2000. It can be any characters here.",
    "process":"obp.getBank",
    "outbound_topic":"",
    "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",
    "message_format":"",
    "example_outbound_message":{
      
    },
    "inbound_topic":"",
    "example_inbound_message":{
      
    },
    "bank_id":"gh.29.uk",
    "programming_lang":"Scala"
  }]
}
Required Roles:
  • CanGetAllDynamicMessageDocs - 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 getAllDynamicMessageDocs, operation_id: OBPv4.0.0-getAllDynamicMessageDocs Tags: Dynamic-Message-Doc,

Update Bank Level Dynamic Message Doc

Update a Bank Level Dynamic Message Doc.

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

URL Parameters:

BANK_ID: gh.29.uk

DYNAMIC_MESSAGE_DOC_ID:

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Typical Successful Response: 

								
									
{
  "outbound_avro_schema":"",
  "inbound_avro_schema":"",
  "adapter_implementation":"",
  "dynamic_message_doc_id":"",
  "description":"Description of the object. Maximum length is 2000. It can be any characters here.",
  "process":"obp.getBank",
  "outbound_topic":"",
  "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",
  "message_format":"",
  "example_outbound_message":{
    
  },
  "inbound_topic":"",
  "example_inbound_message":{
    
  },
  "bank_id":"gh.29.uk",
  "programming_lang":"Scala"
}
Required Roles:
  • CanUpdateDynamicMessageDoc - Please login to request this Role
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-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 updateBankLevelDynamicMessageDoc, operation_id: OBPv4.0.0-updateBankLevelDynamicMessageDoc Tags: Dynamic-Message-Doc,

Update Dynamic Message Doc

Update a Dynamic Message Doc.

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

URL Parameters:

DYNAMIC_MESSAGE_DOC_ID:

JSON response body fields:

description: Description of the object. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Typical Successful Response: 

								
									
{
  "outbound_avro_schema":"",
  "inbound_avro_schema":"",
  "adapter_implementation":"",
  "dynamic_message_doc_id":"",
  "description":"Description of the object. Maximum length is 2000. It can be any characters here.",
  "process":"obp.getBank",
  "outbound_topic":"",
  "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",
  "message_format":"",
  "example_outbound_message":{
    
  },
  "inbound_topic":"",
  "example_inbound_message":{
    
  },
  "bank_id":"gh.29.uk",
  "programming_lang":"Scala"
}
Required Roles:
  • CanUpdateDynamicMessageDoc - 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 updateDynamicMessageDoc, operation_id: OBPv4.0.0-updateDynamicMessageDoc Tags: Dynamic-Message-Doc,