SMS API

SMS API

Purpose

To send SMS notifications to customers, the SMS API provided by the partner is used.

API Contract

Environment	Endpoint
UAT	https://bank.uat.com/notification-service/partner/send/sms
Production (CUG)	https://bank.prod.com/notification-service/partner/send/sms

Request Body (Parameters) (By Nuclei)

• Request Structure:

  {
    "payload": "JSON DATA IN BASE64 ENCODED FORMAT"
  }

• Message Body example (Decoded payload):

  {
    "requestDate": "20200911115412",                     // string (format: milliseconds)
    "reqRefNum": "6baf5d03-7350-4486-bbc6-c76c72fcc152", // string (unique ID of fixed length, used to identify the request)
    "cif": "919434126468",                               // string (customer identification number)
    "msgContent": "Your recharge for Rs.10 was successful. Your Transaction ID is X343434. Please note this reference number." // string
  }

Response Body (from Partner)

• Response Structure:

  {
    "payload": "JSON DATA IN BASE64 ENCODED FORMAT"
  }

• Message Body example (Decoded payload):

  {
    "status": "SUCCESS",                                 // string
    "reqRefNum": "6baf5d03-7350-4486-bbc6-c76c72fcc152", // string
    "requestDate": "20200911115412",                     // string (format: milliseconds)
    "errorMessage": "NA"                                 // string
  }

Status Codes and Descriptions

• status:
  • SUCCESS: SMS sent successfully
  • FAILURE: SMS sending failed