FrameSDK/com.framepayments.framesdk.transfersv2/TransferV2

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.

Constructors

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

Properties

accountTransfer

@SerializedName(value = "account_transfer")

val accountTransfer: TransferV2AccountTransfer? = null

Nested account-transfer detail when type is TransferV2Type.ACCOUNT_TRANSFER.

val amount: TransferV2Money? = null

Transfer amount as { value, currency }.

@SerializedName(value = "canceled_at")

val canceledAt: Int? = null

Unix timestamp when the transfer was canceled, if any.

@SerializedName(value = "completed_at")

val completedAt: Int? = null

Unix timestamp when the transfer completed, if any.

val created: Int? = null

Unix timestamp (seconds) when this transfer was created.

val description: String? = null

Optional description provided when the transfer was created.

val destination: TransferV2Endpoint? = null

Destination endpoint (payment method / account / wallet).

@SerializedName(value = "failed_at")

val failedAt: Int? = null

Unix timestamp when the transfer failed, if any.

val fee: TransferV2Money? = null

Fee amount as { value, currency }.

Unique identifier for this transfer.

val livemode: Boolean? = null

Whether this transfer was created in live mode.

val metadata: Map<String, String>? = null

Arbitrary key-value pairs attached by the merchant.

@SerializedName(value = "net_amount")

val netAmount: TransferV2Money? = null

Amount after fees as { value, currency }.

@SerializedName(value = "next_action")

val nextAction: TransferV2NextAction? = null

Challenge presentation fields when a client action is required.

val payment: TransferV2Payment? = null

Nested payment detail when type is TransferV2Type.PAYMENT.

val payout: TransferV2Payout? = null

Nested payout detail when type is TransferV2Type.PAYOUT.

@SerializedName(value = "pending_at")

val pendingAt: Int? = null

Unix timestamp when the transfer entered pending, if any.

val reference: String? = null

Merchant reference string, if any.

@SerializedName(value = "reversed_at")

val reversedAt: Int? = null

Unix timestamp when the transfer was reversed, if any.

val source: TransferV2Endpoint? = null

Source endpoint (payment method / account / wallet).

val status: TransferV2Status? = null

Coarse lifecycle status.

@SerializedName(value = "object")

val transferObject: String? = null

The object type string returned by the API (e.g. "transfer").

val type: TransferV2Type? = null

Discriminator for which nested detail this transfer carries.