v4.0.0 filtered by tag: Customer-Message (4 APIs)
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](/glossary#Message Doc): 123456
JSON response body fields:
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
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](/glossary#Message Doc): 123456
-
[transport](/glossary#Consumer, Consent, Transport and Payload Security): SMS
JSON response body fields:
{
"success":"Success"
}
-
CanCreateCustomerMessage
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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:
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:
- BANK_ID: gh.29.uk
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
{
"messages":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"date":"2017-09-19T00:00:00Z",
"message":"String",
"from_department":"String",
"from_person":"String"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
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](/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
{
"messages":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"date":"2017-09-19T00:00:00Z",
"transport":"SMS",
"message":"123456",
"from_department":"Open Bank",
"from_person":"Tom"
}]
}
-
CanGetCustomerMessages
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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: