Reminder System (GoPay Genie Card)

This method explains how merchants can display reminders on the GoPay app homepage for time-sensitive actions like bill payments or returns. This feature is limited to selected merchants. To request access, contact the GoPay team with your business use case and provide the reminder template details.

TemplateDetails
TitleThis is a mini app name
DescriptionThis is a field to spec out what the reminder is , max char 50 - 70 char
DueThis is a field to inform when is the due date for the user to do certain action
CTAThis is the copy to indicate the action that a user can do , i.e. Top up , pay, return , etc. Max char 7 - 8 char
URLThis 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 NeededDetails
Mini App BackendCreate a reminder for user in GoPay app
Path/v1/mini-apps/reminder
Hosthttps://public-mini-app-merchants.gopayapi.com
Http MethodPUT

Request Headers:

PropertyData typeRequiredDescription
Debug-IdstringNoThis is an identifier that is used for debugging purposes
Request-IdstringNoThis is an identifier that is used for maintaining idempotency
AuthorizationstringYesBearer Authorization header
This is the token you would receive in the apply token API

Request Body:

PropertyData typeRequiredDescription
template_namestringYesThe name of the template that is registered in GoPay
template_parametersobjectYesThe object which contains notification parameters such as title, description, etc

Response:

PropertyData typeDescription
successbooleanIt will be true if API call is successful and false in case of failure
errorobjectThis object will be non-null only in case of failures
error.descriptionstringThe description of the error
dataobjectThe object containing the reminder details
data.reminder_idstringThe 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 NeededDetails
Mini App BackendRemove reminder on user's phone
Path/v1/mini-apps/reminder/<reminder_id>
Hosthttps://public-mini-app-merchants.gopayapi.com
Http MethodDELETE

Request Headers:

PropertyData typeRequiredDescription
Debug-IdstringNoThis is an identifier that is used for debugging purposes
Request-IdstringNoThis is an identifier that is used for maintaining idempotency
AuthorizationstringYesBearer Authorization header
This is the token you would receive in the apply token API

Response:

PropertyData typeDescription
successbooleanIt will be true if API call is successful and false in case of failure
errorobjectThis object will be non-null only in case of failures
error.codestringThe error code
error.descriptionstringThe 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"
  }
}