API Explorer

v5.1.0 (529 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Customer Message

Create a message for the customer specified by CUSTOMER_ID
Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON request body fields:

from_department: Open Bank

from_person: Tom

message: 123456

transport: SMS

JSON response body fields:

success:

Typical Successful Response:

								
									
{ "success":"Success" }
Required Roles:
  • CanCreateCustomerMessage - 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-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by createCustomerMessage, operation_id: OBPv4.0.0-createCustomerMessage Tags: Customer-Message, Customer, Person,

Create Customer Message

Create a message for the customer specified by CUSTOMER_ID

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON request body fields:

from_department: Open Bank

from_person: Tom

message: 123456

JSON response body fields:

success:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by addCustomerMessage, operation_id: OBPv1.4.0-addCustomerMessage Tags: Customer-Message, Customer, Person,

Get Customer Messages for a Customer

Get messages for the customer specified by CUSTOMER_ID
Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

date: 2020-01-27

from_department: Open Bank

from_person: Tom

id: d8839721-ad8f-45dd-9f78-2080414b93f9

message: 123456

messages:

transport: SMS

Typical Successful Response:

								
									
{ "messages":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "date":"1100-01-01T00:00:00Z", "transport":"SMS", "message":"123456", "from_department":"Open Bank", "from_person":"Tom" }] }
Required Roles:
  • CanGetCustomerMessages - 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-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by getCustomerMessages, operation_id: OBPv4.0.0-getCustomerMessages Tags: Customer-Message, Customer,

Get Customer Messages for all Customers

Get messages for the logged in customer
Messages sent to the currently authenticated user.

Authentication via OAuth is required.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

date: 2020-01-27

from_department: Open Bank

from_person: Tom

id: d8839721-ad8f-45dd-9f78-2080414b93f9

message: 123456

messages:

Typical Successful Response:

								
									
{ "messages":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "date":"1100-01-01T00:00:00Z", "message":"String", "from_department":"String", "from_person":"String" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by getCustomersMessages, operation_id: OBPv1.4.0-getCustomersMessages Tags: Customer-Message, Customer,