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

Package-level declarations

Types

data class CapturePaymentParams(val forageVaultElement: ForageVaultElement<ElementState>, val paymentRef: String)

A model that represents the parameters that Forage requires to capture a payment. CapturePaymentParams are passed to the capturePayment method.

CheckBalanceParams

data class CheckBalanceParams(val forageVaultElement: ForageVaultElement<ElementState>, val paymentMethodRef: String)

A model that represents the parameters that Forage requires to check a card's balance. CheckBalanceParams are passed to the checkBalance method.

DeferPaymentCaptureParams

data class DeferPaymentCaptureParams(val forageVaultElement: ForageVaultElement<ElementState>, val paymentRef: String)

A model that represents the parameters that Forage requires to collect a card PIN and defer the capture of the payment to the server. DeferPaymentCaptureParams are passed to the deferPaymentCapture method.

DeferPaymentRefundParams

data class DeferPaymentRefundParams(val forageVaultElement: ForageVaultElement<ElementState>, val paymentRef: String)

A model that represents the parameters that Forage requires to collect a card PIN and defer the refund of the payment to the server. DeferPaymentRefundParams are passed to the deferPaymentRefund method.

ForageTerminalSDK

class ForageTerminalSDK

The entry point for in-store POS Terminal transactions.

RefundPaymentParams

data class RefundPaymentParams(val forageVaultElement: ForageVaultElement<ElementState>, val paymentRef: String, val amount: Float, val reason: String, val metadata: Map<String, String>? = null)

A model that represents the parameters that ForageTerminalSDK requires to refund a Payment. RefundPaymentParams are passed to the refundPayment method.

TokenizeMagSwipeParams

data class TokenizeMagSwipeParams(val forageConfig: ForageConfig, val track2Data: String, val reusable: Boolean = true)

A model that represents the parameters that ForageTerminalSDK requires to tokenize a card via a magnetic swipe from a physical POS Terminal. This data class is not supported for online-only transactions. TokenizeMagSwipeParams are passed to the tokenizeCard method.

TokenizeManualEntryParams

data class TokenizeManualEntryParams(val foragePanEditText: ForagePANEditText, val reusable: Boolean = true)

A model that represents the parameters that ForageTerminalSDK requires to tokenize a card by entering the card number into a ForagePANEditText. This data class is not supported for online-only transactions. TokenizeManualEntryParams are passed to the tokenizeCard method.