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

CheckBalanceParams

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

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

Constructors

CheckBalanceParams

constructor(forageVaultElement: ForageVaultElement<ElementState>, paymentMethodRef: String, interaction: CardholderInteraction)

Properties

forageVaultElement

val forageVaultElement: ForageVaultElement<ElementState>

A reference to a ForageVaultElement instance (either a ForagePINEditText or a ForagePinPad).

interaction

val interaction: CardholderInteraction

Represents the method of interaction between the cardholder and the terminal. This includes key card details such as PAN (Primary Account Number) and Track 2 data. Use the appropriate implementation of CardholderInteraction based on how the card information is obtained.

For example:
- ManualEntryInteraction: Use when the card details are entered manually.
- MagSwipeInteraction: Use when the card is swiped using the magnetic stripe reader.

paymentMethodRef

val paymentMethodRef: String

A unique string identifier for a previously created PaymentMethod in Forage's database, found in the response from a call to the Create a PaymentMethod endpoint.