Template	Details
Title	This is a mini app name
Description	This is a field to spec out what the reminder is , max char 50 - 70 char
Due	This is a field to inform when is the due date for the user to do certain action
CTA	This is the copy to indicate the action that a user can do , i.e. Top up , pay, return , etc. Max char 7 - 8 char
URL	This is the URL to redirect the user somewhere within the GoPay app , i.e. Your mini app

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.

Integration Needed	Details
Mini App Backend	Create a reminder for user in GoPay app

Path	/v1/mini-apps/reminder
Host	https://public-mini-app-merchants.gopayapi.com
Http Method	PUT

Request Headers:

Property	Data type	Required	Description
Debug-Id	string	No	This is an identifier that is used for debugging purposes
Request-Id	string	No	This is an identifier that is used for maintaining idempotency
Authorization	string	Yes	Bearer Authorization header This is the token you would receive in the apply token API

Request Body:

Property	Data type	Required	Description
template_name	string	Yes	The name of the template that is registered in GoPay
template_parameters	object	Yes	The object which contains notification parameters such as title, description, etc

Response:

Property	Data type	Description
success	boolean	It will be true if API call is successful and false in case of failure
error	object	This object will be non-null only in case of failures
error.description	string	The description of the error
data	object	The object containing the reminder details
data.reminder_id	string	The ID of the reminder

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

Integration Needed	Details
Mini App Backend	Remove reminder on user's phone

Path	/v1/mini-apps/reminder/<reminder_id>
Host	https://public-mini-app-merchants.gopayapi.com
Http Method	DELETE

Request Headers:

Property	Data type	Required	Description
Debug-Id	string	No	This is an identifier that is used for debugging purposes
Request-Id	string	No	This is an identifier that is used for maintaining idempotency
Authorization	string	Yes	Bearer Authorization header This is the token you would receive in the apply token API

Response:

Property	Data type	Description
success	boolean	It will be true if API call is successful and false in case of failure
error	object	This object will be non-null only in case of failures
error.code	string	The error code
error.description	string	The description of the error

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"
  }
}