Create Reminder:

This API can be called by the Mini App backend service to create reminders in the GoPay app.

• GoPay backend will return a reminder_id that can be used later to remove the reminder once the task is completed.
• The merchant should store the reminder_id at their end so they can use it later to delete the reminder if required.

Request Headers:

Request Body:

Response:

Sample Request:

{
  "template_name": "<template_name>", // can be obtained from GoPay team
  "reminder_id": "<reminder_id>",
  // these parameters are not fixed and may vary based on usecase
  "template_parameters": {
    "message": "Food is ready",
    "cta_label_en": "Track",
    "cta_label_id": "Track",
    "amount": 12000
  }
}

Sample Response:

Success Response:

{
  "success": true,
  "data": {
    "reminder_id": "<reminder_id>"
  }
}

Error Response: With appropriate HTTP status codes. Only 5xx would be retriable

{
  "success": false,
  "error": {
    "description": "NotificationTemplate not found"
  }
}

Remove Reminder:

📝

Note

This API access will give you access to remove the created reminder for GoPay users on the GoPay app homepage. It is strictly limited to specific merchants. Please discuss with the GoPay team if you want to use it

This API can be called by the Mini App backend to delete a reminder in the GoPay app.

• The id that is obtained from Create Reminder API needs to be passed as part of the path param for that reminder to be removed from GoPay app
• API returns true if the reminder got removed successfully

Request Headers:

Response:

Sample Response:

Success Response:

{
  "success": true
}

Error Response: With appropriate HTTP status codes. Only 5xx would be retriable

{
  "success": false,
  "error": {
    "description": "Reminder not found"
  }
}