Overview

List of Contents

1. Introduction
2. Guides
3. Get Started
4. Technical Assistant and Support
5. FAQ

Introduction

A MiniApp is a lightweight web application that runs inside the GoPay App ecosystem, enabling businesses to deliver cross-platform services with lower development cost, faster updates, and a user experience close to native apps, while seamlessly integrating with GoPay features such as payments and authentication.

MiniApps let you instantly reach millions of GoPay users with seamless login, built-in payments, native features, fast and low-cost development, instant updates, in-app discovery, and integrated analytics.

MiniApps web apps integrate with GoPay through seamless account login, built-in secure payments, a native in-app experience, and standardized flows that reduce merchant effort while leveraging GoPay’s ecosystem and user base.

To integrate with mini apps, GoPay provide a custom container with its own MiniApp Portal where merchants/mini app developers can directly integrate and upload project versions. This container offers a more seamless experience along with additional functionalities. (docs)

End to End Onboarding Flow

Participants submit the MiniApp form, get workspace access, set up and develop the MiniApp with GoPay support (credentials, APIs, payments), publish and submit for release, after which GoPay approves and rolls out the MiniApp. (docs)

Guides

UI/UX Guidelines

These UI/UX Guidelines must be followed to ensure a secure, consistent, and user-friendly experience within the GoPay App. (docs)

Best Practices

To build a MiniApp, merchants/Mini App developers typically plan their use case, set up the project in the GoPay Portal, integrate login and payments with the GoPay Container SDK, test inside the container, and publish quickly to reach GoPay’s user base. (docs)

Technical Specifications

These are the APIs and SDKs available.

1. Install and Initialize SDK in Frontend. You can't run this locally, please deploy and test on GoPay MiniApp.

   1. Include JSSDK Script: (docs)

      <script src="https://gwk.gopayapi.com/sdk/stable/gp-container.min.js"></script>
      

   2. Call Get Auth Code SDK: (docs)

      window.gpContainer.call(  
        "GPMiniAppAuth",  
        "getAuthCode",  
        {},  
        function(response) {  
          console.log('success:', response);  
        },  
        function(error) {  
          console.log('error:', error);  
        }  
      );
      

   3. Other GoPay Frontend SDKs (docs

2. Use Auth Token to Call GoPay Backend APIs

   Name	Description	Mandatory	Prerequisite
   Get Auth Token	Retrieve user's access token for authentication	M	AuthCode
   Disbursement	Send GoPay coins to user's account	O	AuthToken
   Create Reminder	Set up a reminder for scheduled actions	O	AuthToken
   Remove Reminder	Cancel a previously created reminder	O	AuthToken
   Push Notification	Send notifications to user	O	AuthToken
   Get Profile	Retrieve user's information such as mobile number, email, username	O	AuthToken ConsentApproval

   
   

3. Integrate GoPay Charge API for Payments (docs)

---

Get Started

If you're unsure where to begin with integrating the GoPay Mini App using Container SDK, follow the steps below for a smooth and successful setup:

1. Complete the Mini App Detail Submission
   Please provide the following details during submission. (You may resubmit the form using the same link if you need to update any information.)

   1. Request Consent Approval – Optional: If your website or application required the user information and permission listed below, you must first obtain user consent from GoPay:

      API/SDK	Details
      Get Location	Device location
      Get Device Info	Device information
      Get Camera	Device camera
      Get Profile	Mobile number, email, username

      
      

   2. Allowed Deeplink – Optional: If your Mini App redirects to a GoPay page, please provide a screenshot of the destination.

   3. Whitelisting Domain – Optional: If your Mini App redirects to a specific URL.

2. Request for GoPay Staging App
   Kindly submit your email on the submission form below to request for GoPay App

   1. IOS:
      1. Fill this submission form
      2. Check email from Testflight where you can find the link to install the Testflight app
         Once you install you can find the GoPay App
   2. Android:
      1. Check your email domain
      2. If it's GoPay then fill this submission form
         If it's GoJek then fill this submission form
      3. Check email from firebase where you can find the link to install firebase app.
         Once you install you can find the GoPay App

3. Access to Gopay Mini App Portal
   Please follow the steps below to gain access:

   1. Please wait for us to invite you for login access.
      Ping the support team
   2. Check your email and log in Gopay Mini App Portal

4. Develop MiniApp for Gopay Container SDK
   Install and initialize project setup for MiniApp.

   1. Install VS Code Extension (docs)
   2. Create MiniApp Project (docs)
   3. Test your MiniApp in Emulator (docs)

5. Technical specifications
   GoPay Frontend JSSDKs and Backend APIs (docs)

6. Submit and Publish
   Submit MiniApp bundle for deployment.

   1. Publish and Release a MiniApp (docs)
   2. Test your MiniApp in GoPay (docs )

7. Manage Service Deployments
   Every deployments are managed by GoPay

---

Version History

---

Technical Assistant and Support

For any technical queries or clarifications, please contact the GoPay integration team via email: [email protected]

Hackathon Development Support (TBD)
To streamline hackathon development, the following support will be provided:
Note: We will invite the MiniApp Participant PIC into lark Hackathon support group

1. Invite users into GoPay Portal -> handled by @Abhishek
2. Sharing MiniApp Credentials and Deeplink Construct -> handled by @Janson
3. Approve MiniApp Release -> Jointly handled by @Abhishek @Janson
4. GoPay Staging App -> Jointly handled by @Abhishek @Janson

---

FAQ