Immediately captures a payment via a Element.

  • On success, the object confirms the transaction. The response includes a Forage Payment object.

  • On failure, for example in the case of card_not_reusable or ebt_error_51 errors, the response includes a list of ForageError objects that you can unpack to programmatically handle the error and display the appropriate customer-facing message based on the ForageError.code.

// Example capturePayment call in a PaymentCaptureViewModel.kt
class PaymentCaptureViewModel : ViewModel() {
val snapPaymentRef = "s0alzle0fal"
val merchantId = "mid/<merchant_id>"
val sessionToken = "<session_token>"

fun capturePayment(foragePinEditText: ForagePINEditText, paymentRef: String) =
viewModelScope.launch {
val response = ForageSDK().capturePayment(
foragePinEditText = foragePinEditText,
paymentRef = snapPaymentRef

when (response) {
is ForageApiResponse.Success -> {
val payment = response.toPayment()
// Unpack payment.ref, payment.receipt, etc.
is ForageApiResponse.Failure -> {
val error = response.errors[0]

// handle Insufficient Funds error
if (error.code == "ebt_error_51") {
val details = error.details as ForageErrorDetails.EbtError51Details
val (snapBalance, cashBalance) = details

// display balance to the customer...


A ForageApiResponse object. Use toPayment() to convert the data string to a Payment.



A CapturePaymentParams model that passes a foragePinEditText instance and a paymentRef, returned by the Create a Payment endpoint, that Forage uses to capture a payment.

See also


If the ForageConfig is not set for the provided foragePinEditText.