FrameSDK/com.framepayments.framesdk.transfers/Transfer

Transfer

data class Transfer(val id: String?, val status: TransferStatus?, val amount: Int?, val currency: String?, val description: String?, val payout: String?, val metadata: Map<String, String>?, val livemode: Boolean?, val created: Int?, val transferObject: String?, val platformFee: Int?, val frameFee: Int?, val totalFees: Int?, val grossAmount: Int?, val netAmount: Int?, val failureReason: String?, val chargeIntent: String?, val billingAgreement: String?, val sourcePaymentMethod: FrameObjects.PaymentMethod?, val destinationPaymentMethod: FrameObjects.PaymentMethod?)

Represents a transfer between payment methods returned by the Frame API.

Constructors

constructor(id: String?, status: TransferStatus?, amount: Int?, currency: String?, description: String?, payout: String?, metadata: Map<String, String>?, livemode: Boolean?, created: Int?, transferObject: String?, platformFee: Int?, frameFee: Int?, totalFees: Int?, grossAmount: Int?, netAmount: Int?, failureReason: String?, chargeIntent: String?, billingAgreement: String?, sourcePaymentMethod: FrameObjects.PaymentMethod?, destinationPaymentMethod: FrameObjects.PaymentMethod?)

Properties

val amount: Int?

Transfer amount in the smallest currency unit (e.g., cents).

billingAgreement

@SerializedName(value = "billing_agreement")

val billingAgreement: String?

Identifier of the billing agreement associated with this transfer, if any.

@SerializedName(value = "charge_intent")

val chargeIntent: String?

Identifier of the charge intent associated with this transfer, if any.

val created: Int?

Unix timestamp (seconds) when this transfer was created.

val currency: String?

Three-letter ISO 4217 currency code.

val description: String?

Optional description provided when the transfer was created.

destinationPaymentMethod

@SerializedName(value = "destination_payment_method")

val destinationPaymentMethod: FrameObjects.PaymentMethod?

The payment method funds were pushed to.

@SerializedName(value = "failure_reason")

val failureReason: String?

Human-readable reason why this transfer failed, or null if not failed.

@SerializedName(value = "frame_fee")

val frameFee: Int?

Fee retained by Frame, in the smallest currency unit.

@SerializedName(value = "gross_amount")

val grossAmount: Int?

Total amount before fees, in the smallest currency unit.

val id: String?

Unique identifier for this transfer.

val livemode: Boolean?

Whether this transfer was created in live mode.

val metadata: Map<String, String>?

Arbitrary key-value pairs attached to this transfer by the merchant.

@SerializedName(value = "net_amount")

val netAmount: Int?

Amount received after all fees, in the smallest currency unit.

val payout: String?

Identifier of the associated payout, if any.

@SerializedName(value = "platform_fee")

val platformFee: Int?

Fee retained by the merchant's platform, in the smallest currency unit.

sourcePaymentMethod

@SerializedName(value = "source_payment_method")

val sourcePaymentMethod: FrameObjects.PaymentMethod?

The payment method funds were pulled from.

val status: TransferStatus?

The current lifecycle status of this transfer.

@SerializedName(value = "total_fees")

val totalFees: Int?

Sum of all fees deducted from this transfer, in the smallest currency unit.

@SerializedName(value = "object")

val transferObject: String?

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