TransfersV2API

Provides suspend and callback-based functions for managing V2 transfers (/v2/transfers).

Secret-key calls use com.framepayments.framesdk.FrameAuthMode.Secret. Checkout creates and confirms with Authorization: Bearer chk_sess_… when a checkout client secret is passed.

Functions

Captures a manually authorized payment transfer (optional partial amount).

suspend fun confirmTransfer(transferId: String, checkoutClientSecret: String): Pair<TransferV2?, NetworkingError?>

fun confirmTransfer(transferId: String, checkoutClientSecret: String, completionHandler: (TransferV2?, NetworkingError?) -> Unit)

Confirms a V2 transfer with a checkout-session bearer.

Confirms a deferred-confirm payment transfer and delivers the result via a callback.

Confirms a deferred-confirm payment transfer (secret key).

Creates a V2 transfer. Requires an Idempotency-Key (generated when idempotencyKey is null or blank).

suspend fun createTransfer(request: TransferV2Requests.CreateTransferRequest, checkoutClientSecret: String, idempotencyKey: String? = null, accountId: String? = null): Pair<TransferV2?, NetworkingError?>

Creates a V2 transfer under a checkout session.

Creates a V2 transfer and delivers the result via a callback.

Retrieves a paginated list of V2 transfers.

Retrieves a paginated list of V2 transfers and delivers the result via a callback.

Retrieves an existing V2 transfer by its identifier.

Retrieves an existing V2 transfer by its identifier and delivers the result via a callback.

suspend fun getTransferWith(transferId: String, checkoutClientSecret: String): Pair<TransferV2?, NetworkingError?>

fun getTransferWith(transferId: String, checkoutClientSecret: String, completionHandler: (TransferV2?, NetworkingError?) -> Unit)

Retrieves a V2 transfer with a checkout-session bearer.

Refunds a succeeded payment transfer (optional partial amount).

Updates a deferred-confirm payment transfer before confirm.

suspend fun voidTransfer(transferId: String, idempotencyKey: String? = null): Pair<TransferV2?, NetworkingError?>

Voids a manually authorized payment transfer.