edfapay_softpos_sdk 1.0.8

Helps developers to easly integrate EdfaPay SoftPos to flutter mobile application with few simple steps.

1.0.8

First stable release of the 1.0.8 line (consolidates the 1.0.8-beta.* pre-releases). Native Android dependency bumped com.edfapay:sa-edfapay-revamp from 1.0.7.7 → 1.0.8.

New Features

• EdfaPayPlugin.updateSecurityChecks(config) — remote on/off switch for the SDK's device-security checks (root, emulator, hooking, NFC, internet, etc.). Same encrypted envelope format as setPartnerConfig.

  await EdfaPayPlugin.updateSecurityChecks(encryptedConfig);
  

• EdfaPayPlugin.Utils.securityThreats() / showSecurityStatus() — scan the device and get detected threat ids, or present the built-in Safe/Detected report screen.

  final threats = await EdfaPayPlugin.Utils.securityThreats(); // e.g. ["ROOTED_DEVICE"]
  await EdfaPayPlugin.Utils.showSecurityStatus();
  

• EdfaPayPlugin.configureHook(Hook, {encryptor}) — register transaction/initialize webhooks via the chainable Hook builder (mirrors the native API). The SDK POSTs {"data":"<payload>"} in the background (WorkManager, 5 retries at 1-minute intervals, internet-gated), adding X-Device-Id/X-Device-Time headers. encryptor optionally transforms the base64 payload before sending.

  await EdfaPayPlugin.configureHook(
    Hook()
        .initiate('https://…/init')
        .transaction('https://…/txn'),
    encryptor: (data) => myEncrypt(data),
  );
  

• Multi-profile phone login (Extension) — loginWithPhone, selectUser, and a new onProfileSelection callback on verifyOtp. When a phone number maps to more than one merchant profile, verifyOtp returns the list of UserProfiles via onProfileSelection (instead of onSuccess); pick one and finish authenticating with selectUser. Adds the UserProfile model.

  await EdfaPayPlugin.Extension.loginWithPhone(
    phoneNumber: '+9665XXXXXXXX',
    location: location,
    onSuccess: (login) async {
      // login['sessionId'], login['otpExpireInSeconds']
      await EdfaPayPlugin.Extension.verifyOtp(
        sessionId: login['sessionId'],
        otp: '123456',
        onSuccess: (session) {/* single-profile: logged in */},
        onProfileSelection: (List<UserProfile> profiles) async {
          await EdfaPayPlugin.Extension.selectUser(
            sessionId: login['sessionId'],
            userId: profiles.first.userId!,
            otp: '123456',
            onSuccess: (session) {/* logged in as chosen profile */},
            onError: (e) {},
          );
        },
        onError: (e) {},
      );
    },
    onError: (e) {},
  );
  

Documentation

• README: added "Device Security Checks & Threats", "Transaction & Initialization Webhooks", and "Phone Login & Multi-profile Selection" sections covering the APIs above, plus "Security Status" and "Configure Hook" buttons (with handlers and the models/hook.dart import) in the runnable example app.

1.0.7

Native Android dependency bumped com.edfapay:sa-edfapay-revamp from 1.0.6.4 → 1.0.7.7.

Breaking Changes

• BNPL API renamed to Invoice-based payment API. The BNPL-specific surface is now generic invoice checkout/refund:

  // Before
  EdfaPayPlugin.buyNowPayLater(request: InvoiceRequest(...), onSuccess: (BnplResponse r) {...}, onError: ...);
  
  // Now
  EdfaPayPlugin.invoicePayment(request: InvoicePaymentRequest(...), onSuccess: (InvoicePaymentResponse r) {...}, onError: ...);
  

  • buyNowPayLater() → invoicePayment().
  • checkoutLinkApi() removed; added invoiceRefund(request: InvoiceRefundRequest(...), ...) for invoice refunds.
  • InvoiceRequest → split into InvoicePaymentRequest and InvoiceRefundRequest.
  • BnplResponse → InvoicePaymentResponse.

• BnplProvider enum → PaymentMethod. Values are now tamara, tabby, checkout, unknown, contactless (lowercase), with a PaymentMethod.from(String) factory that maps native names (TAMARA_POS, TABBY_POS, PAYMENT_GATEWAY → checkout, SOFT_POS → contactless).

New Features

• Transaction search & status: searchTxnApi(parameters, onSuccess, onError) and pgTxnStatusApi(sessionId, onSuccess, onError).
• Online receipts (Extension): generateOnlineReceipt(type, id, onSuccess, onError) (returns the receipt URL) and openOnlineReceipt(type, id, onError) (opens it in the browser). Adds ReceiptType { RECONCILIATION, TRANSACTION }.
• Terminal unbinding: Extension.unbindTerminal(onSuccess, onError).
• Device-readiness helpers (Utils) for reliable background reconciliation:
  • Notification (Android 13+): haveNotificationPermission, requestNotificationPermission.
  • Exact alarms (Android 12+): canScheduleExactAlarms, openExactAlarmSettings, requestExactAlarmPermission.
  • Battery unrestricted: isBatteryUnrestricted, openBatteryUnrestrictedSettings, requestBatteryUnrestricted.
  • OEM autostart: deviceNeedsAutostart, openAutostartSettings, requestAutostartPermission.
• Reconciliation notification sounds: theme().setReconciliationNotificationSounds(success:, error:, processing:) accepting base64-encoded sound files.
• API key credential: EdfaPayCredentials.apiKey field and chainable setApiKey(String).
• Env: added REVAMP and DEMO environments.

Improvements

• Callback routing hardened: native callbacks are now routed by a unique per-invocation id instead of by method name, so concurrent/sequential calls to the same method (e.g. repeated refund) no longer overwrite each other's handlers.
• initiate() now reports hostAppType: 'Flutter' to the native SDK.

Bug Fixes

• Notification / location permission requests no longer crash at runtime. Utils.requestNotificationPermission (and requestLocationPermission) threw IllegalStateException: LifecycleOwner … is attempting to register while current state is RESUMED because the native SDK registered the activity-result launcher lazily on tap. It now registers via ActivityResultRegistry (no lifecycle restriction) and unregisters on result. Ships with the native sa-edfapay-revamp update.

1.0.6

• Validate and fix all from 1.0.5
• Random Fixes
• • Fixed Refund by fixing transaction date as TxnParams
• • [601] TMS Update Required handling at any transaction,
• Native Android dependency: com.edfapay:sa-edfapay-revamp:1.0.6.3

1.0.6+4

• Bumped native Android dependency com.edfapay:sa-edfapay-revamp from 1.0.6.3 → 1.0.6.4.
• Packaging: published archive included the sample/ app directory and edfapay-softpos-sdk-sample.zip (~47 MB). No Dart API changes. (Reverted in 1.0.6+5.)

1.0.6+5

• Packaging: removed the bundled sample/ app and edfapay-softpos-sdk-sample.zip from the published package, shrinking the archive back to ~84 KB. No Dart API or native dependency changes.

1.0.6+6

• Transaction: withRRN() and withTxnNumber() now default type to TransactionType.PURCHASE (previously null).
• Transaction.toMap(): renamed serialized keys to match the backend API — txnNumber → transaction_number, txnDate → created_date, type → operation_type. This is the fix behind "Fixed Refund by fixing transaction date", since refund/void reference an original transaction by these fields.

1.0.5

Breaking Changes

• TxnParams: Removed required transactionType parameter. Transaction type is now inferred from the method called (purchase, refund, etc.).

  // Before
  TxnParams(amount: '10.00', transactionType: TransactionType.PURCHASE);
  
  // Now
  TxnParams(amount: '10.00');
  

• Transaction.txnDate: Changed from String? to DateTime? for type safety.

  // Before
  Transaction.withRRN('123456', txnDate: '2026-03-14');
  
  // Now
  Transaction.withRRN('123456', DateTime.now());
  

• Env enum: Removed REVAMP environment. Use DEVELOPMENT, STAGING, SANDBOX, or PRODUCTION.

• Simplified Terminal Binding: Removed standalone bindTerminal() method; terminal binding is now handled through TerminalBindingTask.bind().

Major Architectural Update

• Complete rewrite of the Dart-Native bridge, migrating away from legacy Pigeon platform channels to a direct MethodChannel approach for robust performance and exact alignment with Native SDK standards.
• Typed Models: Replaced generic and risky array structures with strongly-typed Dart models (TxnParams, EdfaPayCredentials, Transaction, Pagination, Location).
• Chainable Builders: Introduced chainable builders for SdkTheme and PresentationConfig to mirror native implementation.
• Callback Refactoring: Flutter side callbacks are now invoked directly with mapped Function.apply payloads for seamless error handling and multiple parameter execution.

Massive API Expansion

The previous versions of the SDK only exposed a fraction of the native capabilities (purchase, refund, reconcile, txnHistory, etc.). 1.0.5 directly maps every feature available in the Android Native SDK to Flutter.

• New Transaction Flows: authorize, capture, changePin, activateCard, void, reverse, reverseLastTransaction, and txnDetail.
• New Session Management: getSessionId, getSessionDetail, getSessionList, logoutCurrentSession, and logoutSession.
• New Reconciliation & Terminal Management: reconciliationHistory, reconciliationDetail, reconciliationReceipt, terminalInfo, activateTerminal, deActivateTerminal, and syncTerminal.
• New Utilities & Extensions: EdfaPayPlugin.Extension (initKernels, loginWithToken, getTerminalConfig, getUserInfo, etc.) and EdfaPayPlugin.Utils (getDeviceId, currentLocation, isLocationMocked, etc.).

New Features

• Terminal Binding Task: Added Terminal and TerminalBindingTask models for improved terminal binding workflow.

  EdfaPayPlugin.initiate(
    credentials: credentials,
    onSuccess: (sessionId) => print('Initialized'),
    onTerminalBindingTask: (task) {
      // Show native binding UI or bind programmatically
      task.bind(); // or task.bind(terminal: task.terminals.first);
    },
    onError: (e) => print('Error: $e'),
  );
  

• Extension.getUserInfo(): New method to retrieve current user information.

• TxnParams.setOriginalTransaction(): New method to set original transaction reference for refund/capture operations.

• BNPL (Buy Now Pay Later): Added buyNowPayLater() method supporting Tamara and Tabby providers.

  EdfaPayPlugin.buyNowPayLater(
    request: BnplRequest(
      provider: BnplProvider.TAMARA,
      merchantId: 'merchant-id',
      amount: 11100, // in minor units (cents)
      currency: 'SAR',
      phoneNumber: '[phone]',
      email: '[e-mail]',
      orderReferenceId: 'ORD-111',
      orderNumber: '10111',
      invoice: BnplInvoice(
        total: 11100,
        lineItems: [
          BnplLineItem(sku: 'SKU-001', description: 'Product', unitCost: 11100, quantity: 1, netTotal: 11100, total: 11100),
        ],
      ),
      additionalData: BnplAdditionalData(storeId: 'STORE-01'),
    ),
    onSuccess: (response) {
      // Launch response.checkoutDeeplink in browser
      print('Checkout URL: ${response.checkoutDeeplink}');
    },
    onError: (e) => print('Error: $e'),
  );
  

Improvements

• ProcessCompleteCallback Type Alias: Transaction callbacks now use the ProcessCompleteCallback type alias for cleaner method signatures.
• SdkTheme.setPresentation(): Improved error messaging and internal code refactoring.

Bug Fixes & Maintenance

• Improved error stack trace handling in native bridge

• Bug fixes and performance enhancements in MethodChannel communications

• Code cleanup and formatting improvements

• Documentation Reference: For full implementation details, see the EdfaPay SoftPOS SDK Documentation.

---

0.0.3

• Revamp version of sdk

0.0.4

• Revamp version of sdk
• fixes & enhancement

0.0.5

• Revamp version of sdk
• fixes & enhancement

1.0.0+2

• Revamp version of sdk.
• Fixes & enhancement.
• Fix terminal token login.

1.0.0+3

• Added ability to change presentation
  • Presentation.FULLSCREEN
  • Presentation.DIALOG_CENTER
  • Presentation.DIALOG_TOP_FILL
  • Presentation.DIALOG_BOTTOM_FILL
  • Presentation.DIALOG_TOP_START
  • Presentation.DIALOG_TOP_END
  • Presentation.DIALOG_TOP_CENTER
  • Presentation.DIALOG_BOTTOM_START
  • Presentation.DIALOG_BOTTOM_END
  • Presentation.DIALOG_BOTTOM_CENTER

    // Usage:
    EdfaPayPlugin.theme()
        .setPresentation(
            Presentation.DIALOG_CENTER
                .sizePercent(0.85) // scale to width of screen 1.0 to 0.20
                .dismissOnBackPress(true) 
                .dismissOnTouchOutside(true)
                .animateExit(true)
                .animateEntry(true)
                .dimBackground(true)
                .dimAmount(1.0) // scale to 1.0 to 0.0
                .marginAll(0) // open number
                .cornerRadius(20)  // open number
                .marginHorizontal(10)  // open number
                .marginVertical(10)  // open number
                .setPurchaseSecondaryAction(PurchaseSecondaryAction.none)
        );
    

• Added ability enable Secondary/Post Purchase Transaction Action.
  • PurchaseSecondaryAction.reverse
  • PurchaseSecondaryAction.refund
  • PurchaseSecondaryAction.none

    // Usage:
    EdfaPayPlugin.theme()
        .setPresentation(
            Presentation.DIALOG_CENTER
                .setPurchaseSecondaryAction(PurchaseSecondaryAction.reverse)
        );
    

• Added ability to decide UI Flow Type at the time of transaction.
  • FlowType.immediate
  • FlowType.status
  • FlowType.detail

    // Usage:
    EdfaPayPlugin.pay(
        params,
        flowType: FlowType.detail,
        /* */
    );
    

1.0.4

• Added ability to enable/disable PIN PAD shuffles at Pin Transaction.

  // Usage:
  EdfaPayPlugin.theme()
    .setPresentation(
        Presentation.DIALOG_CENTER
            .setShufflePinPad(true); // default false
    );
  

• Added ability to start transaction from remote source (LocalNetwork).

  • Note: Make sure to open RemoteChannel after successful SDK initialization.

    // Usage: Make sure to open RemoteChannel after initialize successful 
    EdfaPayPlugin.RemoteChannel.LocalNetwork(8080, 3.0).open();