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/sendSMSSend SMS
Send a plain text SMS to a customer mobile number.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
mobile_number | string | required | Customer mobile number (Pakistani format, e.g. 03001234567). |
message | string | required | SMS message text. Max 160 characters for single SMS. |
reserved | string | optional | Optional metadata. |
POST
/api/sendEmailSend Email
Send a plain text email to a customer.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | required | Customer email address. |
subject | string | required | Email subject line. |
body | string | required | Email body content. Plain text. |
reserved | string | optional | Optional metadata. |
POST
/api/sendEmailNewSend Email (New)
Enhanced email endpoint — supports HTML body and file attachments.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | required | Customer email address. |
subject | string | required | Email subject line. |
body | string | required | Email body. Supports basic HTML. |
attachments | string[] | optional | Base64-encoded attachment files. |
reserved | string | optional | Optional metadata. |
Response (all three endpoints)
{
"response_Code": "00",
"response_description": "Notification Sent Successfully",
"reserved": ""
}Next
Update 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": ""
}'