right logo image
right logo image
Log on

v4.0.0 filtered by tag: Customer-Message (4 APIs)

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

Create Customer Message

Create a message for the customer specified by CUSTOMER_ID

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

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 createCustomerMessage, operation_id: OBPv1.4.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:

JSON request body fields:

  • from_department: Open Bank

  • from_person: Tom

  • [message](/glossary#Message Doc): 123456

  • [transport](/glossary#Consumer, Consent, Transport and Payload Security): SMS

JSON response body fields:

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,

Get Customer Messages for a Customer

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

Authentication via OAuth is required.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

  • [date](/glossary#Scenario 6: Update credit score based on transaction and device data.): 2020-01-27

  • from_department: Open Bank

  • from_person: Tom

  • [message](/glossary#Message Doc): 123456

Typical Successful Response:

								
									
{
  "messages":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "date":"2017-09-19T00: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 getCustomerMessages, operation_id: OBPv1.4.0-getCustomerMessages Tags: Customer-Message, Customer,

Get Customer Messages for a Customer

Get messages for the customer specified by CUSTOMER_ID
Authentication is Mandatory

URL Parameters:

JSON response body fields:

  • [date](/glossary#Scenario 6: Update credit score based on transaction and device data.): 2020-01-27

  • from_department: Open Bank

  • from_person: Tom

  • [message](/glossary#Message Doc): 123456

  • [transport](/glossary#Consumer, Consent, Transport and Payload Security): SMS

Typical Successful Response:

								
									
{
  "messages":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "date":"2017-09-19T00: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,