FrameSDK/com.framepayments.framesdk.transfers/TransferRequests/CreateTransferRequest

CreateTransferRequest

data class CreateTransferRequest(val amount: Int, val accountId: String, val currency: String? = null, val sourcePaymentMethodId: String? = null, val destinationPaymentMethodId: String? = null, val description: String? = null, val metadata: Map<String, String>? = null)

Request payload for creating a new transfer.

Constructors

CreateTransferRequest

constructor(amount: Int, accountId: String, currency: String? = null, sourcePaymentMethodId: String? = null, destinationPaymentMethodId: String? = null, description: String? = null, metadata: Map<String, String>? = null)

Properties

@SerializedName(value = "account_id")

val accountId: String

Identifier of the destination account to receive the transfer. Required.

val amount: Int

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

val currency: String? = null

Three-letter ISO 4217 currency code. Defaults to the account's currency if omitted.

val description: String? = null

Optional description that appears on the transfer record.

destinationPaymentMethodId

@SerializedName(value = "destination_payment_method_id")

val destinationPaymentMethodId: String? = null

Identifier of the payment method to push funds to. Uses the account default if omitted.

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

Optional arbitrary key-value pairs to attach to the transfer.

sourcePaymentMethodId

@SerializedName(value = "source_payment_method_id")

val sourcePaymentMethodId: String? = null

Identifier of the payment method to pull funds from. Uses the account default if omitted.