ListBeneficiariesQuery

public struct ListBeneficiariesQuery : Sendable

The beneficiaries query model.

  • The number of items per page.

    Declaration

    Swift

    public let limit: UInt?
  • Start after offset amount of items.

    Declaration

    Swift

    public let offset: UInt?
  • The type of beneficiary.

    Declaration

    Swift

    public let type: String?
  • The status of the beneficiary.

    Declaration

    Swift

    public let status: BeneficiaryStatus?
  • The legal type of the beneficiary.

    Declaration

    Swift

    public let legalType: BeneficiaryLegalType?
  • Exclude beneficiaries without transactions.

    Declaration

    Swift

    public let withTransactionsOnly: Bool?
  • Auxiliary constructor.

    Declaration

    Swift

    public init(limit: UInt? = nil,
                offset: UInt? = nil,
                type: String? = nil,
                status: BeneficiaryStatus? = nil,
                legalType: BeneficiaryLegalType? = nil,
                withTransactionsOnly: Bool? = nil)

    Parameters

    limit

    The number of items per page.

    offset

    Start after offset amount of items.

    type

    The type of beneficiary.

    status

    The status of the beneficiary.

    legalType

    The legal type of the beneficiary.

    withTransactionsOnly

    Exclude beneficiaries without transactions.