Send Message

The Send Message endpoint enables you to send a predefined message to the cardholder either by SMS or Email. Thredd can configure the message using a selection of variables.

📘

Note

If the SMS or Email option is selected and a bespoke message has not been configured, the default Thredd message is sent. Character limitation is in line with standard SMS message capacity.

You can set send a message to a cardholder by making a POST request to the endpoint. For example

{{base-url}}/ws/api/v1/Ws_SendMessage

The request body must include one of the following fields in the request to identify the customer you want to send a message to:

• PAN where you know the 16-digit PAN of the card.
• PublicToken where you know the 9-digit public token for the card.

The EventId field in the request specifies the type of message being sent out. These messages can be configured in Smart Client.

The below example shows a request that sends both an email and SMS to the cardholder, where MailOrSMS has a field value of 1. The EventId field value is set to 1 specifying that the message sent to the cardholder will be related to card activation.

{
  "IssCode": "PMT",
  "ItemSrc": "2",
  "PAN": "9999999999999999",
  "EventId": "1",
  "MailOrSMS": "2"
}

If successful, a 201 response is returned.

{
  "IssCode": "PMT",
  "PublicToken": "123456789",
  "SysDate": "2025-07-22",
  "ActionCode": "000"
}

📘

More Information

• For detailed field descriptions for the fields in the request and response, see Send Message - Field Descriptions.
• For information on the different event IDs, see Event ID.
• To view the endpoint in the API Explorer, see Send Message.