forage-android/com.joinforage.forage.android.pos.services/ForageTerminalSDK

ForageTerminalSDK

class ForageTerminalSDK

The entry point for in-store POS Terminal transactions.

A ForageTerminalSDK instance interacts with the Forage API.

You need to call ForageTerminalSDK.init to initialize the SDK. Then you can perform operations like: 

// Example: Initialize the Forage Terminal SDK
val forageTerminalSdk = ForageTerminalSDK.init(
    context = androidContext,
    posTerminalId = "<id-that-uniquely-identifies-the-pos-terminal>",
    forageConfig = ForageConfig(
        merchantId = "123ab45c67",
        sessionToken = "sandbox_ey123..."
    )
)
Content copied to clipboard

See also

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
suspend fun checkBalance(params: CheckBalanceParams): ForageApiResponse<String>

Checks the balance of a previously created PaymentMethod via a ForageVaultElement (either a ForagePINEditText or a ForagePinPad).

Link copied to clipboard
suspend fun deferPaymentCapture(params: DeferPaymentCaptureParams): ForageApiResponse<String>

Submits a card PIN via a via a ForageVaultElement (either a ForagePINEditText or a ForagePinPad) and defers payment capture to the server.

Link copied to clipboard
suspend fun deferPaymentRefund(params: DeferPaymentRefundParams): ForageApiResponse<String>

Collects a card PIN for an EBT payment via a ForageVaultElement (either a ForagePINEditText or a ForagePinPad) and defers the refund of the payment to the server.

Link copied to clipboard
suspend fun swipeMagneticCard(device: PaymentDevice): ForageApiResponse<MagSwipeInteraction>

Use the MagneticStrip Reader of a Worldline Ingenico PaymentDevice to read an EBT card's magnetic stripe data.