GlomoPay Flutter SDK v0.0.13

Deprecated - This documentation is for Flutter SDK v0.0.13, which is past end of life and is no longer supported. Versions 1.0.3 and below are deprecated. For the latest version, see Flutter SDK v2.

The GlomoPay Flutter SDK provides a seamless, secure, and customizable payment checkout experience for your Flutter applications. Supports all Glomo payment flows (like 3DS auth or bank redirects), built-in security compliance checks, and error handling.

• A GlomoPay account with API keys (public key starting with live_ or test_)
• An order ID generated from your server via the GlomoPay API

• Flutter 3.0 or higher
• Dart 2.17 or higher
• Android: minSdkVersion 21 or higher
• iOS: iOS 13.0 or higher

Add the glomopay_sdk to your pubspec.yaml dependencies:

dependencies:
  flutter:
    sdk: flutter
  glomopay_sdk: ^0.0.13

Then run:

flutter pub get

Import it in your Dart code:

import 'package:glomopay_sdk/glomopay_sdk.dart';

Add the required permissions in your android/app/src/main/AndroidManifest.xml:

<manifest xmlns:android="http://schemas.android.com/apk/res/android">
    <!-- Required for the checkout flow -->
    <uses-permission android:name="android.permission.INTERNET"/>

    <!-- Required if you need users to upload images/documents during checkout -->
    <uses-permission android:name="android.permission.CAMERA" />
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" android:maxSdkVersion="32" />
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="29" />
</manifest>

Add the keys to your ios/Runner/Info.plist:

<dict>
    <!-- Required for camera/file uploads during the checkout process -->
    <key>NSCameraUsageDescription</key>
    <string>This app requires access to the camera to upload documents required for payment verification.</string>
    <key>NSPhotoLibraryUsageDescription</key>
    <string>This app requires access to the photo library to select documents for payment verification.</string>
</dict>

Import the library and display the GlomoPayCheckout widget:

import 'package:flutter/material.dart';
import 'package:glomopay_sdk/glomopay_sdk.dart';

class PaymentScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Complete Payment')),
      body: GlomoPayCheckout(
        config: const GlomoPayConfig(
          publicKey: 'test_pk_12345',
          orderId: 'order_abc123',
        ),
        onPaymentSuccess: (GlomoPayPayload payload) {
          print('Payment succeeded! Payment ID: ${payload.paymentId}');
        },
        onPaymentFailure: (GlomoPayPayload payload) {
          print('Payment failed with Order ID: ${payload.orderId}');
        },
        onSdkError: (List<SdkError> errors) {
          print('SDK Error: ${errors.first.message}');
        },
        onConnectionError: (ConnectionError error) {
          print('Connection error: ${error.message}');
        },
        onPaymentTerminate: (TerminationSource source) {
          print('User cancelled checkout via $source');
          Navigator.pop(context);
        },
      ),
    );
  }
}

• Glomo Payment Stack Support - Handles standard checkout flows and overlay redirects (3DS, bank pages) seamlessly.
• Robust Security - Built-in jailbreak and root detection to ensure transactions happen on secure devices.
• Error Monitoring - Built-in error tracking and diagnostics.
• Comprehensive Error Handling - Handles connection drops, DNS issues, HTTP errors, and validation mistakes gracefully.
• Native Support - Full support for Android and iOS native features like the camera and file pickers required by certain payment methods.
• Mock Mode - Easy testing with test keys (test_..., mock_...).

/**

• The main checkout widget. Embed it in your widget tree
• to present the GlomoPay payment UI. */

/**

• Configuration object passed to GlomoPayCheckout.
• Contains keys, order info, and environment settings. */

/**

• Returned via onPaymentSuccess and onPaymentFailure callbacks.
• Contains the order reference and optional verification data. */

/**

• Represents an SDK-level error such as validation failure
• or a forbidden device condition. */

/**

• Represents a network or connectivity error encountered
• during the checkout flow. */

/**

• Indicates how the user exited the checkout flow
• before completing payment. */

/**

• Internal lifecycle states of the checkout session.
• Observable via the checkout lifecycle. */

• iOS Swiping - The SDK intercepts iOS downward swipe gestures to dismiss the payment sheet and triggers onPaymentTerminate with TerminationSource.userDismiss.
• Android Back Button - Automatically overrides standard pop. First checks if the Flow WebView overlay (e.g., 3DS bank page) can go back. Does so accordingly until the modal is closed, returning TerminationSource.backButton.

Using a public key that starts with test_ or mock_ shifts the SDK into mock mode.

In this mode:

• Connection heuristics allow mock traffic.
• You can simulate fake transactions without real money movement.

• Invalid Order ID format - Ensure orderId starts with "order_" and has appropriate length.
• SDK crashes immediately on open - Ensure config.publicKey is correctly set and starts with the expected prefix (test_ or live_).
• File upload buttons do nothing - Run flutter clean and ensure Camera/Storage permissions were explicitly granted in the native AndroidManifest and Info.plist layers.
• Device Forbidden (Error) - A root/jailbroken device will immediately trigger onSdkError. Test within your emulator.

• The SDK performs jailbreak/root detection at startup. Compromised devices trigger onSdkError with SdkErrorType.deviceForbidden.
• All checkout traffic is served over HTTPS. SSL errors are surfaced via onConnectionError.
• Public keys are validated before any network request is made.
• Payment credentials never pass through your application code - they are handled entirely within the secure WebView.

The SDK exports the following from package:glomopay_sdk/glomopay_sdk.dart:

• GlomoPayCheckout - The main checkout widget.
• GlomoPayConfig - Configuration model.
• GlomoPayPayload - Payment result payload.
• SdkError / SdkErrorType - SDK error model and type enum.
• ConnectionError / ConnectionErrorType - Connection error model and type enum.
• TerminationSource - Enum for checkout exit source.

• Flutter SDK v2 (Latest)
• Flutter SDK v1 (Archived)
• Changelog
• React Native SDK
• Unified SDK (Web)