CreatePayoutMethodRequest

public struct CreatePayoutMethodRequest : Encodable, Sendable

Payout method request model.

  • The ID of the Payout Method in your own system.

    Declaration

    Swift

    public let externalId: String

  • Whether this is the primary Payout Method of the Beneficiary.

    Declaration

    Swift

    public let isPrimary: Bool

  • The country of the Payout Method. If not provided, the country of the Beneficiary will be used.

    Declaration

    Swift

    public let country: String?

  • The currency of the Payout Method. If not provided, the currency of the Beneficiary will be used.

    Declaration

    Swift

    public let currency: String?

  • A free-text label to identify the Payout Method.

    Declaration

    Swift

    public let label: String?

  • Details of the Payout Method.

    Declaration

    Swift

    public let payoutMethodDetails: PayoutMethodDetails

  • Auxiliary constructor.

    Declaration

    Swift

    public init(payoutMethodDetails: PayoutMethodDetails,
            isPrimary: Bool,
            externalId: String,
            country: String? = nil,
            currency: String? = nil,
            label: String? = nil)

    Parameters

    payoutMethodDetails

    Details of the Payout Method.
    isPrimary

    A Whether this is the primary Payout Method of the Beneficiary.
    externalId

    The ID of the Payout Method in your own system.
    country

    The country of the Payout Method. If not provided, the country of the Beneficiary will be used.
    currency

    The currency of the Payout Method. If not provided, the currency of the Beneficiary will be used.
    label

    A free-text label to identify the Payout Method.