Messages

Retrieve Service Messages

Service messages are delivered to partners via the user interface or programmatically through the API. These messages serve as the bank’s official means of communicating with all partners regarding system-wide issues, maintenance schedules, upgrades, and other pertinent notifications.
To retrieve Service Messages via API, initiate a GET request directed to the following endpoint:

https://cubi-sandbox-api.customersbank.com/partners/v1/Messages

This endpoint provides access to the latest Service Messages, enabling developers to stay informed about critical updates and operational notifications seamlessly within their applications.

Example Request:

GET /partners/v1/messages HTTP/1.1
Host: cubi-sandbox-api.customersbank.com
Authorization: Bearer ••••••

A successful request will generate a response of 200 – Success.

Response Data Element Details:

Name	Type	Description
pageSize	int32	number of items to display on page
pageOffset	int32	offset index indicating starting point for page items
totalPages	int32	total number of pages
totalItemCount	int32	total count of items across all pages
items	array of objects \| null	items model
> messageText	string \| null	free form text containing communication from the bank
> type	string	specifies the type of message, which can be one of the following: Banner; Advisory

Error Handling
Common errors will include:
400 – Bad Request
401 – Unauthorized
403 – Forbidden
404 – Not Found
422 – Client Error
For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.