This guide explains end-to-end MiniApp flows, which may involve a combination of frontend SDKs and backend APIs.
This is mandatory for all miniapps, this allows users to open the miniapp without any login requirements. You will receive gopay_account_id (user unique identifier) and authToken (authorization header for other GoPay BE API)
| Name | Description | Mandatory | Prerequisite |
|---|---|---|---|
| FE SDK Script | Initiate SDK Script | M | |
| Get Auth Code | Use this SDK to get auth code (Active GoPay User session) | M | SDKScript |
| Get Auth Token | Use this API to retrieve user's access token for authentication | M | AuthCode AuthCredentials |
This is mandatory if you use payments on your miniapp, this allows users to do payments seamlessly inside GoPay App. The journey once user initiate payments, users will redirect to GoPay Payment review page and will redirect back to the miniapp after transactions.
| Name | Description | Mandatory | Prerequisite |
|---|---|---|---|
| Get B2B Access Token | Initiate order with Super App Backend Merchant access token is needed for verification purposes | O | Bi Snap Activation IP Whitelisting |
| Initiate Host to Host Payment | Create Payment Deeplink with Super App backend | O | B2BAccessToken PointofPurchaseID |
| Launch Payment | Use this SDK to automatically redirect users to the GoPay app to complete the payment, then return them to your Mini App. This is the FE Payment Response | O | Initiate Host to Host Payment |
| Notify | Use this API to get transaction status. This is the BE Payment Response. | O | |
| Refund | Initiating refund for GoPay and GoPay Tokenization (non Pre-Auth) transaction | O | |
| Order History URL Configuration | GoPay to Configure the URL allowing users redirect to the merchant's order history page from GoPay's order history page. If no URL is configured, users are redirected to the merchant's home page. | O | Seamless Login (if not implemented globally) |
Note:
- Payments only works in production host, currently it will NOT work on sandbox host (it will only redirect to browser only)
- Please ensure that seamless login is enabled globally, as we will add deeplink redirection from the user's order history for all transactions. "Once UAT sign off in staging, please request another modify request and select payments to share your "Order History URL" as informed in the project tracker on miniapp workbook"