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

CapturePaymentParams

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

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

Constructors

constructor(forageVaultElement: ForageVaultElement<ElementState>, paymentRef: 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.

paymentRef

val paymentRef: String

A unique string identifier for a previously created Payment in Forage's database, returned by the Create a Payment endpoint.