Templates

Alert Templates define the user‑facing content delivered for alerts. They manage channel‑specific messaging (email, SMS, push, web), content type, locale, and publishing state, allowing institutions to customize how alerts are presented across channels and languages.

End-user benefits

• Alerts use standardized templates to deliver easy‑to‑understand and uniform messages.
• Messaging is tailored for each delivery channel to improve readability and usability.
• Supports language and regional formats to ensure alerts are clear and appropriate for customers.

Integration capabilities

• List templates with filters: alert type name, channel, id, locale, state (DRAFT, PUBLISHED, ARCHIVED).
• Create, update, and delete templates; set content type, channel, locale, and vendor context where applicable.
• Templates define the content of alerts by channel. Supports variable substitution using a variableMap for dynamic content like account numbers, balances, and transaction amounts.

Supported channels

Channel	Description
EMAIL	Email — subject and body
SMS	SMS body
PUSH	Push notification body
WEB	Web notification body

Template content types

Content type	Description
EMAIL_SUBJECT	Email subject line
EMAIL_BODY	Email body
SMS_BODY	SMS content
PUSH_BODY	Push content
WEB_BODY	Web notification content

Scopes

Scope	Description
alertMgmt:read	Read alert types and associated templates
alertMgmt:write	Write alert types and associated templates

Required headers

Header	Description
Authorization	Bearer OAuth 2.0 access token
transactionId	Unique request identifier

Error codes

System (PRMSYS_*)

Code	Message	HTTP Status Code
PRMSYS_10001	Cross talk / concurrency error occurred	400
PRMSYS_10002	Malformed input data	400
PRMSYS_10003	Unknown application error occurred	400
PRMSYS_10004	Error occurred while validating JWT token	400
PRMSYS_10005	Resource of name already exists	204
PRMSYS_10006	Requested resource of identifier doesn't exist	400
PRMSYS_10007	Resource of identifier already exists	400
PRMSYS_10008	Requested resource of name doesn't exist	400
PRMSYS_10015	Required attribute missing	400
PRMSYS_10016	Non Printable ASCII character detected	400

Validation (PRMVAL_*)

Code	Message	HTTP Status Code
PRMVAL_10001	Path parameter doesn't match request body value	400
PRMVAL_10002	Invalid value for field	400
PRMVAL_10003	Invalid institution	400
PRMVAL_10005	Invalid channel type	400
PRMVAL_10006	Invalid alert type	400
PRMVAL_10007	Field is required	400
PRMVAL_10008	Field is invalid	400

Endpoints

Create Alert Template

Create a new alert template for your financial institution. When you create a template, you define: -

Delete Alert Template

Delete an alert template that is no longer needed. This permanently removes the template from the database.

List Alert Templates

Retrieve a list of all alert templates configured for the financial institution. The response includes

Update Alert Template

Update an existing alert template. You can modify the template content, status, channel, content type,