FrameSDK/com.framepayments.framesdk.chargeintents/ChargeIntentAPI

ChargeIntentAPI

object ChargeIntentAPI

Provides coroutine-based and callback-based methods for managing charge intents via the Frame API.

Each operation is available in two flavors: a suspend function for use with coroutines and an overload that accepts a completion handler for callback-based callers.

Functions

Link copied to clipboard
suspend fun cancelChargeIntent(intentId: String): Pair<ChargeIntent?, NetworkingError?>
fun cancelChargeIntent(intentId: String, completionHandler: (ChargeIntent?, NetworkingError?) -> Unit)

Cancels a charge intent, preventing it from being confirmed or captured.

Link copied to clipboard
suspend fun captureChargeIntent(intentId: String, request: ChargeIntentsRequests.CaptureChargeIntentRequest): Pair<ChargeIntent?, NetworkingError?>
fun captureChargeIntent(intentId: String, request: ChargeIntentsRequests.CaptureChargeIntentRequest, completionHandler: (ChargeIntent?, NetworkingError?) -> Unit)

Captures a previously authorized charge intent for the specified amount.

Link copied to clipboard
suspend fun confirmChargeIntent(intentId: String, clientSecret: String): Pair<ChargeIntent?, NetworkingError?>
fun confirmChargeIntent(intentId: String, clientSecret: String, completionHandler: (ChargeIntent?, NetworkingError?) -> Unit)

Confirms a server-minted charge intent in-app, moving it to an authorized state.

Link copied to clipboard
suspend fun createChargeIntent(request: ChargeIntentsRequests.CreateChargeIntentRequest): Pair<ChargeIntent?, NetworkingError?>
fun createChargeIntent(request: ChargeIntentsRequests.CreateChargeIntentRequest, completionHandler: (ChargeIntent?, NetworkingError?) -> Unit)

Creates a new charge intent, attaching the current Sonar session ID and live fraud signals before sending.

Link copied to clipboard
suspend fun getAllChargeIntents(page: Int?, perPage: Int?): Pair<ChargeIntentResponses.ListChargeIntentsResponse?, NetworkingError?>
fun getAllChargeIntents(page: Int?, perPage: Int?, completionHandler: (ChargeIntentResponses.ListChargeIntentsResponse?, NetworkingError?) -> Unit)

Retrieves a paginated list of all charge intents for the merchant.

Link copied to clipboard
suspend fun getChargeIntent(intentId: String, clientSecret: String): Pair<ChargeIntent?, NetworkingError?>
fun getChargeIntent(intentId: String, clientSecret: String, completionHandler: (ChargeIntent?, NetworkingError?) -> Unit)

Retrieves a single server-minted charge intent in-app using its client_secret.

Link copied to clipboard
suspend fun updateChargeIntent(intentId: String, request: ChargeIntentsRequests.UpdateChargeIntentRequest): Pair<ChargeIntent?, NetworkingError?>
fun updateChargeIntent(intentId: String, request: ChargeIntentsRequests.UpdateChargeIntentRequest, completionHandler: (ChargeIntent?, NetworkingError?) -> Unit)

Updates mutable fields on an existing charge intent.

Link copied to clipboard
suspend fun voidRemainingChargeIntent(intentId: String): Pair<ChargeIntent?, NetworkingError?>
fun voidRemainingChargeIntent(intentId: String, completionHandler: (ChargeIntent?, NetworkingError?) -> Unit)

Voids the uncaptured remainder of a partially captured charge intent.