Quick Start

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

1. Onboard as a Merchant and activate GoPay
   Visit Midtrans and complete your merchant registration. (docs)

2. Contact Midtrans Account Manager
   Provide your Merchant ID (found in the Midtrans dashboard) to receive your PoP ID. (docs)

3. 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. Submit your production URL for domain whitelisting.

   2. List down any APIs or SDKs you plan to add to your Mini App.

   3. 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 System Info	System information
      Get Camera	Device camera
      Get Profile	Mobile number, email, username

      
      

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

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

5. Contact GoPay
   Request Credentials: Before using any GoPay APIs, you must request credentials from GoPay which will be used as the Authorization Header when calling getAuthToken. These credentials will only be shared after the Mini App Deeplink has been provided. (docs)

6. SDK Setup
   Install and Initialize SDK in Frontend. Note: you can't run this locally, please deploy and test on GoPay MiniApp.

   1. Include SDK 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);  
        }  
      );
      

   
   

7. Technical Specification
   These are the APIs and SDKs available.

   1. Use Auth Token to Call GoPay Backend APIs (docs)

      Name	Description	Mandatory	Prerequisite
      Get Auth Token	Retrieve user's access token for authentication	M	AuthCode
      Reward	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

      
      

   2. GoPay Frontend SDKs (docs)

   3. Integrate GoPay SNAP for Payments (docs)"
      Note: For mini apps, Midtrans payment deeplink is not supported, and a sandbox environment is not available.

      Name	Description	Mandatory	Prerequisite
      Get B2B Access Token	Initiate order with Super App Backend Merchant access token is needed for verification purposes	O	AuthToken
      Initiate Host to Host Payment	Create Payment Deeplink with Super App backend	O	AuthToken
      Launch Payment	Use this SDK to automatically redirect users to the GoPay app to complete the payment, then return them to your Mini App.	O	AuthToken

---

Version History

---

Technical Assistant and Support

For any technical queries or clarifications, please contact the GoPay integration team via email: [email protected] or MiniApp Technical Support @Janson

---

FAQ