paytrack docs
Reminders
Queue payment follow-up reminders and inspect delivery activity.
Overview
Reminder endpoints help finance teams trigger SMS or email follow-ups for due and overdue Payment Plan payments. API v1 still accepts `trackId` for backward compatibility. Access depends on plan and the reminders:send scope.
Required scope
reminders:sendEndpoints
Operations
Available API methods for this resource.
POST/api/v1/reminders/sendSend or queue a reminder.
GET/api/v1/remindersList reminder templates or jobs.
GET/api/v1/reminders/logsInspect reminder delivery logs.
Request example
Example
curl https://paytrack.ng/api/v1/reminders/send \
-X POST \
-H "Authorization: Bearer $PAYTRACK_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"trackId": "trk_123",
"channel": "sms",
"message": "Your instalment payment is due today."
}'Response example
Example
{
"success": true,
"data": {
"id": "rem_123",
"channel": "sms",
"status": "queued"
},
"request_id": "req_xxx"
}Error example
Example
{
"success": false,
"error": {
"code": "validation_error",
"message": "The request failed validation.",
"details": {}
},
"request_id": "req_xxx"
}