Sign in
latestOpenAPI 3.1.02026-08-101511.6 KB

f6a21c6d1c5b

SMS messages

Send an SMS to a customer

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.).<br> 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.

post/v1/sms/messages

Request body

person_idstring required

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

textstring required

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

purposestring required

The purpose of the SMS.

idempotency_keystring uuid required

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

Example request

{
  "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"
}

Response

Accepted

idstring

A unique ID of the message that has been sent.

messagestring

A short description about the request status.

Example response

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