Skip to content
/SMS messages

SMS Service (1.0)

Download OpenAPI description
sms.json
sms.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/digital-banking/sms/

SMS messages

Operations

Send an SMS to a customer

Request

Sends an SMS to the customer's verified mobile number. You can use this endpoint to send informational texts to your customers, such as notifications about transactions (e.g., amounts debited or credited or request for purchases) or reminders (e.g., minimum amount due for credit cards, loans, etc.) or other informational messages (e.g., account statement generated, end of month account balance, etc.).
Important: You cannot use this endpoint for use cases that require Strong Customer Authentication (SCA) (i.e., confirmation via OTP). In such cases, please use the dedicated SMS challenges endpoints.

Bodyapplication/jsonrequired
person_idstringrequired

The person_id of the customer to whom the SMS should be sent.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
textstringrequired

The text of the SMS to be sent. A maximum of 160 characters.

Example: "Account Statement for the month of July has been generated. Please login to your account to view."
purposestringrequired

The purpose of the SMS.

Example: "Account statements"
idempotency_keystring(uuid)required

A randomly generated UUID which the server uses to recognize subsequent retries of the same request.

Example: "504f6816-f7b5-4965-bc35-69acadc9f5c7"
application/json
{
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "text": "Account Statement for the month of July has been generated. Please login to your account to view.",
  "purpose": "Account statements",
  "idempotency_key": "504f6816-f7b5-4965-bc35-69acadc9f5c7"
}

Responses

Accepted

Bodyapplication/json
idstring

A unique ID of the message that has been sent.

Example: "4d9d9eab-0392-4ffb-a9c6-dac9f18e3411"
messagestring

A short description about the request status.

Example: "SMS has been accepted for processing."
Response
application/json
{
  "id": "4d9d9eab-0392-4ffb-a9c6-dac9f18e3411",
  "message": "SMS has been accepted for processing."
}