kuickpayDeveloper Portal
Institution/Hybrid/Notifications

Notifications

Send SMS and email notifications to your customers — bill reminders, payment confirmations, or any message. Three endpoints are available.

POST/api/sendSMS

Send SMS

Send a plain text SMS to a customer mobile number.

Request Parameters

ParameterTypeRequiredDescription
mobile_numberstringrequiredCustomer mobile number (Pakistani format, e.g. 03001234567).
messagestringrequiredSMS message text. Max 160 characters for single SMS.
reservedstringoptionalOptional metadata.

POST/api/sendEmail

Send Email

Send a plain text email to a customer.

Request Parameters

ParameterTypeRequiredDescription
emailstringrequiredCustomer email address.
subjectstringrequiredEmail subject line.
bodystringrequiredEmail body content. Plain text.
reservedstringoptionalOptional metadata.

POST/api/sendEmailNew

Send Email (New)

Enhanced email endpoint — supports HTML body and file attachments.

Request Parameters

ParameterTypeRequiredDescription
emailstringrequiredCustomer email address.
subjectstringrequiredEmail subject line.
bodystringrequiredEmail body. Supports basic HTML.
attachmentsstring[]optionalBase64-encoded attachment files.
reservedstringoptionalOptional metadata.

Response (all three endpoints)

{
  "response_Code": "00",
  "response_description": "Notification Sent Successfully",
  "reserved": ""
}
Next
Update SAF status
SAF Status →
Send SMS — Request
curl -X POST https://uat-adminapi.kuickpay.com/api/sendSMS \
  -H "X-API-KEY: your_api_key" \
  -H "IN-ID: your_initiator_id" \
  -H "Content-Type: application/json" \
  -d '{
    "mobile_number": "03001234567",
    "message": "Your bill of Rs.2500 is due on June 30. Pay now via any Kuickpay channel.",
    "reserved": ""
  }'