API Explorer

v5.1.0 (505 APIs)

Anfitrión de la API: https://api3.openbankproject.com
Banco
Cuentas
Vistas
Contrapartes
Transacciones

Create Bank Level Dynamic Message Doc

Create a Bank Level Dynamic Message Doc.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

description: This an optional field. Maximum length is 2000. It can be any characters here.

process: obp.getBank

JSON response body fields:

description: This an optional field. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Respuesta Exitosa Típica:

								
									
{ "outbound_avro_schema":"", "inbound_avro_schema":"", "adapter_implementation":"", "dynamic_message_doc_id":"", "description":"This an optional field. 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" }
Roles Requeridos:
  • CanCreateBankLevelDynamicMessageDoc - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
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.

Authentication is Mandatory

JSON request body fields:

description: This an optional field. Maximum length is 2000. It can be any characters here.

process: obp.getBank

JSON response body fields:

description: This an optional field. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Respuesta Exitosa Típica:

								
									
{ "outbound_avro_schema":"", "inbound_avro_schema":"", "adapter_implementation":"", "dynamic_message_doc_id":"", "description":"This an optional field. 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" }
Roles Requeridos:
  • CanCreateDynamicMessageDoc - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
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.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

DYNAMIC_MESSAGE_DOC_ID:

JSON response body fields:

Respuesta Exitosa Típica:

								
									
true
Roles Requeridos:
  • CanDeleteBankLevelDynamicMessageDoc - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
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.

Authentication is Mandatory

URL Parameters:

DYNAMIC_MESSAGE_DOC_ID:

JSON response body fields:

Respuesta Exitosa Típica:

								
									
true
Roles Requeridos:
  • CanDeleteDynamicMessageDoc - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
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.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

DYNAMIC_MESSAGE_DOC_ID:

JSON response body fields:

description: This an optional field. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Respuesta Exitosa Típica:

								
									
{ "outbound_avro_schema":"", "inbound_avro_schema":"", "adapter_implementation":"", "dynamic_message_doc_id":"", "description":"This an optional field. 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" }
Roles Requeridos:
  • CanGetBankLevelDynamicMessageDoc - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
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.

Authentication is Mandatory

URL Parameters:

DYNAMIC_MESSAGE_DOC_ID:

JSON response body fields:

description: This an optional field. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Respuesta Exitosa Típica:

								
									
{ "outbound_avro_schema":"", "inbound_avro_schema":"", "adapter_implementation":"", "dynamic_message_doc_id":"", "description":"This an optional field. 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" }
Roles Requeridos:
  • CanGetDynamicMessageDoc - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
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.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

description: This an optional field. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Respuesta Exitosa Típica:

								
									
{ "dynamic-message-docs":[{ "outbound_avro_schema":"", "inbound_avro_schema":"", "adapter_implementation":"", "dynamic_message_doc_id":"", "description":"This an optional field. 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" }] }
Roles Requeridos:
  • CanGetAllDynamicMessageDocs - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
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.

Authentication is Mandatory

JSON response body fields:

description: This an optional field. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Respuesta Exitosa Típica:

								
									
{ "dynamic-message-docs":[{ "outbound_avro_schema":"", "inbound_avro_schema":"", "adapter_implementation":"", "dynamic_message_doc_id":"", "description":"This an optional field. 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" }] }
Roles Requeridos:
  • CanGetAllDynamicMessageDocs - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
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.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

DYNAMIC_MESSAGE_DOC_ID:

JSON response body fields:

description: This an optional field. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Respuesta Exitosa Típica:

								
									
{ "outbound_avro_schema":"", "inbound_avro_schema":"", "adapter_implementation":"", "dynamic_message_doc_id":"", "description":"This an optional field. 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" }
Roles Requeridos:
  • CanUpdateDynamicMessageDoc - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
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.

Authentication is Mandatory

URL Parameters:

DYNAMIC_MESSAGE_DOC_ID:

JSON response body fields:

description: This an optional field. Maximum length is 2000. It can be any characters here.

process: obp.getBank

Respuesta Exitosa Típica:

								
									
{ "outbound_avro_schema":"", "inbound_avro_schema":"", "adapter_implementation":"", "dynamic_message_doc_id":"", "description":"This an optional field. 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" }
Roles Requeridos:
  • CanUpdateDynamicMessageDoc - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by updateDynamicMessageDoc, operation_id: OBPv4.0.0-updateDynamicMessageDoc Tags: Dynamic-Message-Doc,