forage-android/com.joinforage.forage.android.ecom.services/ForageSDK

ForageSDK

class ForageSDK

The entry point to the Forage SDK.

A ForageSDK instance interacts with the Forage API to process online-only payments.

You need an instance of the ForageSDK to perform operations like:

// Example: Create a ForageSDK instance
val forage = ForageSDK()
Content copied to clipboard

See also

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
suspend fun capturePayment(params: CapturePaymentParams): ForageApiResponse<String>

Immediately captures a payment via a com.joinforage.forage.android.ui.ForagePINEditText Element.

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

Checks the balance of a previously created PaymentMethod via a ForagePINEditText Element.

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

Submits a card PIN via a com.joinforage.forage.android.ui.ForagePINEditText Element and defers payment capture to the server.

Link copied to clipboard
suspend fun tokenizeEBTCard(params: TokenizeEBTCardParams): ForageApiResponse<String>

Tokenizes an EBT Card via a ForagePANEditText Element.