Overview

List of Contents

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.

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

Include JSSDK Script: (docs)

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

Call Get Auth Code SDK: (docs)

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

Other GoPay Frontend SDKs (docs

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

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:

Complete theMini App Detail Submission (SKIP if you dont use any of these)
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.
Request for GoPay Staging App (SKIP if you've already given the 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
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
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)
Technical specifications
GoPay Frontend JSSDKs and Backend APIs (docs)
Submit and Publish
Submit MiniApp bundle for deployment.
1. Publish and Release a MiniApp (docs)
2. Test your MiniApp in GoPay (docs )
Manage Service Deployments
Every deployments are managed by GoPay

Version History

SDK Version	Description	GoPay App Version
1.0	Initial Release	1.57 and onwards

Technical Assistant and Support

For any technical queries or clarifications, please contact the GoPay integration team via email: GoPay-mini-app-integrations@gojek.com

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

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

FAQ

Category	Questions	Answer
Most Frequent	Why i'm getting errors when calling getAuthCode	Make sure you're calling getAuthCode correctly and call getAuthCode only after deploying the mini app, not when running locally. The SDK works as a bridge between the mini app and GoPay. If you run locally, there’s no mini app container for the SDK to connect to, so getAuthCode won’t work. You may use the MiniApp Deeplink provided by GoPay to test this.
	What i must call getAuthToken	getAuthToken gives you token that will be used to call other GoPay BE APIs and user's account id. Make sure you get the credentials via Email to be used as the Authorization header.
	What is the difference between pre-launch and post-launch consents	Some features require user consent. Pre-launch consent: Shown as a popup when the mini app is first opened; can be either mandatory or optional. Post-launch consent: Shown as a popup only when the getConsent SDK is called; must always be optional.
	Do we have a sandbox or staging environment for testing?	We don't at this moment, currently all testing is pointing at GoPay production. What we can do is update the redirectURL to point MiniApp staging or production environments.
	How payments work inside GoPay MiniApp	Payments in a GoPay MiniApp work through a one-time checkout flow. Your backend needs to call the Charge API for hackathon to create a Payment Deeplink, then from the MiniApp you launch that deeplink using the launchPayment SDK. This will take the user to the GoPay payment page to complete the transaction, and once done, the user is automatically redirected back to your MiniApp. To confirm the result, you should always verify the payment status from your backend or via BI-SNAP notification.
General	How do I register as a merchant?	If you're not yet integrated with GoPay via Midtrans, please register through the official guide .
	Where do I find my Merchant ID?	You can find your Merchant ID on your Midtrans dashboard or by contacting your Account Manager. (docs)
	What is a PoP ID?	A Point of Purchase ID (PoP ID) is provided by GoPay for payment tracking. You can request this from your business or partnership contact at GoPay.
	When will I receive my PoP ID?	You will receive your PoP ID after tokenization is completed and the Partnership team generates it. Reach out to your GoPay contact if it hasn’t been shared yet.
	Can I onboard multiple mini apps under one Merchant ID?	Yes, it's possible to register multiple mini apps under the same Merchant ID. Each mini app will have a unique `gopay_mini_app_id` and `PoP ID`.
	What value needs to be inputted into the authorization header in the request?	The authorization header should include either `Bearer` or `Basic`, depending on the API and credentials required for the specific request. More details are available in the backend API documentation.
	How long does onboarding take?	Onboarding typically takes around 5–7 working days.
	Where will my mini app be shown in the GoPay app?	You can reach out to the Midtrans sales team or GoPay business counterpart for the details
SDK & Frontend	Where do I get the Mini App SDK?	The GoPay Mini App SDK is available Here
	Can I use my existing SNAP Checkout Midtrans integration?	Yes, you can. However, merchants must include the PoP ID in the existing Snap Checkout API so that GoPay can identify mini app channels and charge MDR (Merchant Deduction Rate) accordingly. (docs )
	Can I use my existing tokenization integration?	No, at the moment, tokenized payments are not supported in the mini app payment integration
	Are recurring payments supported?	No, at the moment, recurring payments or subscriptions are not supported in the mini app payment integration.
	What is the incremental work in the payment if I have integrated previously with Midtrans?	Merchants should share the PoP ID in the header for non-BI SNAP API or body for BI SNAP API for payment API and should trigger the API through payment SDK
	How to integrate with the payment API?	Please use the charge api for hackathon
	What’s the flow for payments?	The user experience will be: FE(MiniApp) → BE → Get redirect URL→ Open payment (GoPay) → Redirect back(MiniApp).
	How do I get an auth code?	To retrieve the auth code, you might call `getAuthCode()` in SDK.
	Why auth code is needed?	The authCode can only be generated when the user opens the Mini App because it serves as real-time proof that the request is from an active, authenticated GoPay session. Since it’s tied to the user’s current login state and expires quickly, it’s not possible or secure to provide it in advance. If we were to provide it in advance, there would be no real validation of the user’s session.
	How long is it valid?	The auth code is valid for 6 minutes.
	How do I get access token?	Please use the auth code in backend API `/v1/mini-apps/authorizations/token`.
	Can I reuse the token?	Yes, the token can be reused. Tokens do not expire and can be safely cached per user.
Disbursement	Can I send GoPay Coins or balance?	Yes, via /`v1/mini-apps/cashback`. Currently, only GoPay Coins are available for disbursement.
	Do I need a wallet balance?	Yes, you need to top up the wallet balance before sending GoPay Coins. Please reach out to the Midtrans sales team or GoPay business counterpart to get the VA to top up.
Permissions	How to get user location?	Please use `getLocation()` in SDK.
Reminder & Notification	Can I send reminders?	Yes, you can send a reminder via `/v1/mini-apps/reminder`. But please discuss with your Midtrans sales team or GoPay business counterpart before using it.
	Can I delete a reminder?	Yes, you can delete the reminder via `/v1/mini-apps/reminder/<id>`.
	Can I send push notifications?	Yes, you can send PN in GoPay app via `/v1/mini-apps/notifications/push`.
Troubleshooting	What if auth code fails?	If the auth code fails, retry within 6 minutes. Make sure the user has given consent.
Support	Who do I contact for help?	For any technical support, you can send out an email to GoPay-mini-app-integrations@gojek.com or reach out to your Midtrans sales team or GoPay business counterpart.
Additional Details	Can I use the GoPay sandbox app for testing?	GoPay does not provide a separate sandbox app. However, once your GoPay mini app ID is generated, your merchant account will be granted direct access to the mini app for testing purposes.
	Is there any limit request per second for the Push Notification API?	There is no limit for sending the PN as of now
	How do I check if a user is on the latest supported version of the GoPay app?	For any technical support, you can send out an email to GoPay-mini-app-integrations@gojek.com
	What happens if the user closes the app before completing payment?	The transaction will remain in an incomplete state. You can monitor status on the midtrans dashboard.
	How can I validate that a payment has been completed?	Please use the `/v1.0/debit/notify` webhook from the GoPay backend. It confirms payment success and provides reference details.
	Can I personalize push notifications per user behavior?	Yes, as long as you manage targeting and parameters from your backend. The API supports custom fields through `template_parameters`.
	What do I do if the final URL doesn't load?	Make sure the domain is whitelisted and matches with the one submitted. Please also check if your Mini App ID is active and all dependencies (client ID, tokens, SDK) are properly integrated.
	How can I check if my domain is whitelisted?	If your mini app isn't loading or returns an unauthorized error, your mini-app domain may not be whitelisted yet by GoPay team. Please reach out to GoPay-mini-app-integrations@gojek.com to ensure it's been reviewed and whitelisted.
	What should I do if I need to update my domain or URL after onboarding?	You must contact the GoPay Mini App team via email: GoPay-mini-app-integrations@gojek.com to review and re-whitelist the new domain. Updating domains without whitelisting will result in connection failures.
	Can I update my Mini App logo, name, or metadata after launch?	Yes, please reach out to your Midtrans sales team or GoPay business counterpart to submit updated assets. Changes will be reflected after approval and deployment.
	Why am I getting a 401 Unauthorized error?	This usually means your auth token is missing, expired, or incorrect. Double-check if you are sending the token in the Authorization header and that it’s valid.
	My payment is stuck in "pending", what should I do?	Check the Midtrans dashboard for transaction status. Make sure PoP ID is included in the payment call and that redirect/callback URLs are configured correctly.
	Is there a staging environment?	Currently, there's no public GoPay Mini App staging environment. All testing need to be completed using production credentials with limited access to the app through whitelisted accounts.
	How to configure redirection after payment has been completed?	You dont need to configure redirection, it happens automatically after using Launch Payment
	How do we test the payment process to the GoPay app?	Currently, there’s no public GoPay Mini App staging environment. For testing purposes, we typically support merchants by funding a small amount to their account so they can test the flow in the production environment. This setup works as a semi-production test.
	How do we test the redirection to the GoPay app?	We’ll provide a staging deeplink to open the Mini App in the GoPay app. To test redirection, merchants must implement the payment API, which redirects users to GoPay for payment. After a successful payment, it will automatically redirect back to the Mini App, but only if launch paymentused to open the payment deeplink.
Consent	Can i use different phone number if the consent is set as mandatory?	No, you can't use different phone number.