Skip to content

grab/superapp-sdk / skills

grabjs-superapp-sdk

Verified

API reference for `@grabjs/superapp-sdk`. Use when building a MiniApp that runs in the Grab SuperApp WebView and needs to call native features (camera, payments, authorization, authentication, permission, location, device storage, container UI customization) via the Grab `JSBridge`. Keywords: miniapp, webview, android, ios, jsbridge, grab, superapp.

references/modules/CheckoutModule.md

View on GitHub
# CheckoutModule

## API Reference

SDK module for triggering native payment flows via `JSBridge`.

| Method | Returns | Description |
| :--- | :--- | :--- |
| `triggerCheckout(request: TriggerCheckoutRequest)` | `Promise<TriggerCheckoutResponse>` | Triggers the native checkout flow for payment processing. |

## `triggerCheckout`

Triggers the native checkout flow for payment processing.

**OAuth Scope:** mobile.checkout

**Signature:** `triggerCheckout(request: TriggerCheckoutRequest): Promise<TriggerCheckoutResponse>`

This method can return the following `status_code` values:
- `200` (OK): Checkout completed successfully. The `result` contains TriggerCheckoutResult.
- `400` (Bad Request): Invalid request parameters.
- `403` (Forbidden): Client is not authorized to trigger checkout.
- `500` (Internal Server Error): An unexpected error occurred.
- `501` (Not Implemented): Requires Grab app environment.

```typescript
import { CheckoutModule, isSuccess, isError } from '@grabjs/superapp-sdk';

// Initialize the checkout module
const checkout = new CheckoutModule();

// Trigger checkout with response params
const transactionResponse = await createTransaction(); // Call POST /grabpay/partner/v4/charge/init from Grab API to create a transaction
const response = await checkout.triggerCheckout(transactionResponse);

// Handle the response
if (isSuccess(response)) {
  console.log('Transaction ID:', response.result.transactionID);
  switch (response.result.status) {
    case 'Success':
      console.log('Transaction successful');
      break;
    case 'Failure':
      console.log('Transaction failed:', response.result.errorMessage, response.result.errorCode);
      break;
    case 'Pending':
      console.log('Transaction pending');
      break;
    case 'Cancel':
      console.log('User cancelled the checkout');
      break;
  }
} else if (isError(response)) {
  switch (response.status_code) {
    case 403:
      console.log('No permission to trigger checkout');
      // Trigger IdentityModule.authorize() for scope 'mobile.checkout', then reload via ScopeModule.reloadScopes() and try again
      break;
    default:
      console.error(`Error ${response.status_code}: ${response.error}`);
  }
} else {
  console.error('Unhandled response');
}
```
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 322kUpdated Claude CodeCodexVerifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 198kUpdated Claude CodeCodexVerifiedInstall