FrameSDK/com.framepayments.framesdk.transfersv2

Package-level declarations

Types

FrameThreeDSecureChallengePresenting

interface FrameThreeDSecureChallengePresenting

Presents a 3D Secure challenge. Implemented by the UI layer.

FrameThreeDSecureChallengeResult

enum FrameThreeDSecureChallengeResult : Enum<FrameThreeDSecureChallengeResult>

Result of presenting a 3D Secure challenge.

FrameTransferV2Error

sealed class FrameTransferV2Error : Exception

Errors raised while confirming a V2 transfer from the app.

FrameTransferV2Outcome

sealed class FrameTransferV2Outcome

The result of confirming a V2 transfer from the app.

TransfersV2API

object TransfersV2API

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

TransferV2

data class TransferV2(val id: String, val transferObject: String? = null, val type: TransferV2Type? = null, val status: TransferV2Status? = null, val description: String? = null, val amount: TransferV2Money? = null, val fee: TransferV2Money? = null, val netAmount: TransferV2Money? = null, val livemode: Boolean? = null, val created: Int? = null, val pendingAt: Int? = null, val completedAt: Int? = null, val failedAt: Int? = null, val canceledAt: Int? = null, val reversedAt: Int? = null, val reference: String? = null, val metadata: Map<String, String>? = null, val source: TransferV2Endpoint? = null, val destination: TransferV2Endpoint? = null, val payment: TransferV2Payment? = null, val payout: TransferV2Payout? = null, val accountTransfer: TransferV2AccountTransfer? = null, val nextAction: TransferV2NextAction? = null)

A V2 transfer (Core::Transfer) returned by /v2/transfers.

TransferV2AccountRef

data class TransferV2AccountRef(val id: String, val accountObject: String? = null, val name: String? = null)

Minimal account reference on a V2 endpoint.

TransferV2AccountTransfer

data class TransferV2AccountTransfer(val status: String? = null, val failureCode: String? = null, val failureReason: String? = null)

Nested account-transfer detail on an account_transfer-type V2 transfer.

TransferV2Address

data class TransferV2Address(val line1: String? = null, val line2: String? = null, val city: String? = null, val state: String? = null, val postalCode: String? = null, val country: String? = null)

Address fields used on V2 shipping / billing.

TransferV2Confirmation

class TransferV2Confirmation(checkoutClientSecret: String? = null, challengePresenter: FrameThreeDSecureChallengePresenting?, polling: TransferV2Confirmation.PollingConfiguration = PollingConfiguration(), confirmTransfer: suspend (transferId: String) -> TransferV2? = { id -> val token = checkoutClientSecret if (!token.isNullOrEmpty()) TransfersV2API.confirmTransfer(id, token).first else TransfersV2API.confirmTransfer(id).first }, loadTransfer: suspend (transferId: String) -> TransferV2? = { id -> val token = checkoutClientSecret if (!token.isNullOrEmpty()) TransfersV2API.getTransferWith(id, token).first else TransfersV2API.getTransferWith(id).first }, sleep: suspend (Long) -> Unit = { delay(it) })

Confirms a V2 transfer from the app, driving a 3D Secure challenge when the API asks for one.

TransferV2Endpoint

data class TransferV2Endpoint(val paymentMethod: FrameObjects.PaymentMethod? = null, val account: TransferV2AccountRef? = null, val wallet: TransferV2WalletRef? = null)

A source or destination slot on a V2 transfer response.

TransferV2Endpoints

sealed class TransferV2Endpoints : FrameNetworkingEndpoints

Defines the network endpoints for the Transfers V2 API (/v2/transfers).

TransferV2Money

data class TransferV2Money(val value: Int, val currency: String? = null)

Amount expressed as { value, currency } on the V2 Transfers API.

TransferV2NextAction

data class TransferV2NextAction(val type: String? = null, val redirectUrl: String? = null, val useFrameSDK: UseFrameSDK? = null)

Challenge presentation fields for client-side 3DS (when the API exposes them).

TransferV2Payment

data class TransferV2Payment(val status: String? = null, val authorizationMode: String? = null, val receiptEmail: String? = null, val statementDescriptor: String? = null, val productId: String? = null, val paymentLinkId: String? = null, val subscriptionId: String? = null, val invoiceId: String? = null, val cartData: Map<String, String>? = null, val amountAuthorized: TransferV2Money? = null, val amountCaptured: TransferV2Money? = null, val amountRefunded: TransferV2Money? = null, val failureCode: String? = null, val failureReason: String? = null, val shipping: TransferV2Shipping? = null)

Nested payment detail on a payment-type V2 transfer.

TransferV2Payout

data class TransferV2Payout(val status: String? = null, val rail: String? = null, val speed: String? = null, val failureCode: String? = null, val failureReason: String? = null)

Nested payout detail on a payout-type V2 transfer.

TransferV2Requests

object TransferV2Requests

Contains request payload models for the Transfers V2 API (/v2/transfers).

TransferV2Responses

object TransferV2Responses

Contains response payload models for the Transfers V2 API.

TransferV2Shipping

data class TransferV2Shipping(val name: String? = null, val phone: String? = null, val carrier: String? = null, val trackingNumber: String? = null, val address: TransferV2Address? = null)

Shipping block returned on a V2 payment.

TransferV2Status

enum TransferV2Status : Enum<TransferV2Status>

Coarse lifecycle status on a V2 TransferV2.

TransferV2Type

enum TransferV2Type : Enum<TransferV2Type>

Discriminator for which nested detail a V2 transfer carries.

TransferV2WalletRef

data class TransferV2WalletRef(val id: String, val walletObject: String? = null, val provider: String? = null, val chain: String? = null, val token: String? = null)

Minimal wallet reference on a V2 endpoint.

UpdateTransferRequest

typealias UpdateTransferRequest = TransferV2Requests.CreateTransferRequest

Partial update body for PATCH /v2/transfers/:id (pre-confirm payment fields).

UseFrameSDK

data class UseFrameSDK(val source: String?, val directoryServerName: String? = null, val challengeUrl: String? = null)

A 3D Secure challenge session for the client to complete.