TransferFundsRequest

public struct TransferFundsRequest : Codable, Sendable

Send funds request model.

  • The uuid of the beneficiary account to send the funds to.

    Declaration

    Swift

    public let beneficiaryUuid: String

  • The ID of the payout method that the transfer should be paid to. If none is provided, the primary payout method will be used.

    Declaration

    Swift

    public let payoutMethodUuid: String?

  • The amount is the value associated with the request, in cents. e.g. If you want to debit 1 USD the value must be amount: 100

    Declaration

    Swift

    public let amount: Int64

  • Structure used to apply service fees to system events and transactions.

    Declaration

    Swift

    public let serviceFees: [ServiceFee]?

  • A small description to identify the transaction.

    Declaration

    Swift

    public let description: String?

  • This value is used for idempotency purposes.

    Declaration

    Swift

    public let externalId: String

  • Allows for any number of custom metadata keys and values to be stored with a given transaction.

    Declaration

    Swift

    public let metadata: [String : CustomValue]?

  • Auxiliary constructor.

    Declaration

    Swift

    public init(
    beneficiaryUuid: String,
    amount: Int64,
    externalId: String,
    payoutMethodUuid: String? = nil,
    serviceFees: [ServiceFee]? = nil,
    description: String? = nil,
    metadata: [String: CustomValue]? = nil)

    Parameters

    beneficiaryUuid

    The uuid of the beneficiary account to send the funds to.
    amount

    The amount is the value associated with the request, in cents. e.g. If you want to debit 1 USD the value must be amount: 100
    externalId

    This value is used for idempotency purposes.
    payoutMethodUuid

    The ID of the payout method that the transfer should be paid to. If none is provided, the primary payout method will be used.
    serviceFees

    Structure used to apply service fees to system events and transactions.
    description

    A small description to identify the transaction.
    metadata

    Allows for any number of custom metadata keys and values to be stored with a given transaction.