DisplayMessage
A message intended for consumption by an end user. The message field can be used to directly present to an end user. The priority field should control the order in which the message should be displayed relative to other DisplayMessage elements. The message_id is useful for interpreting each message as a programmatic occurrence. The message_content will contain parameters related to each specific message type.
The valid values for message_id and their message_content fields are:
| message_id | purpose | default message | message_content fields |
|---|---|---|---|
| SF-1000 | Code has been accepted | Code has been accepted | credential_identifier |
| SF-1001 | Code does not exist | Code is invalid | credential_identifier |
| SF-1002 | Code already redeemed | Code already redeemed | credential_identifier |
| SF-1003 | Code expired | Code is expired | credential_identifierexpiration_date |
| SF-1004 | Code is locked | Code is currently in use on another transaction | credential_identifier |
| SF-1005 | Only one code allowed per transaction | Only one code allowed per transaction | |
| SF-1006 | Minimum purchase amount not met | Offer not vaid - $X minimum required | credential_identifierminimum_purchase_amount |
| SF-1007 | Purchase requirement not met | Required items not purchased | credential_identifier |
| SF-1008 | Offer is not valid at location | Offer is not valid at this location | credential_identifier |
| SF-1009 | Offer is expired | Offer has expired | credential_identifierexpiration_date |
| SF-1010 | Offer is not available within time window | Offer only available X (Ex: "On Weekdays", or "On Sundays", or "During Happy Hour") | credential_identifieravailability |
| SF-1011 | Offer is not available in-store | Offer is not available in-store | credential_identifier |
- messageType: string
- messageType: object
_content - messageType: string
_id - priorityType: integer
Integer numbers.