Beneficiary

public struct Beneficiary : Codable, Sendable

Beneficiary model.

  • The beneficiary identifier.

    Declaration

    Swift

    public let beneficiaryUuid: String

  • The account uuid.

    Declaration

    Swift

    public var accountUuid: String?

  • The unique identifier of this beneficiary in your own system.

    Declaration

    Swift

    public let externalId: String

  • Whether the beneficiary can be used for local or international transactions.

    Declaration

    Swift

    public var typeString: String

  • Whether the beneficiary can be used for local or international transactions. Check typeString if nil.

    Declaration

    Swift

    public var type: BeneficiaryType? { get }

  • Whether the beneficiary is an individual or a business.

    Declaration

    Swift

    public var legalTypeString: String?

  • Whether the beneficiary is an individual or a business. Check legalTypeString if nil.

    Declaration

    Swift

    public var legalType: BeneficiaryLegalType? { get }

  • The business’ name.

    Declaration

    Swift

    public var businessName: String?

  • The user account current status.

    Declaration

    Swift

    public var statusString: String

  • The beneficiary account current status. Check statusString if nil.

    Declaration

    Swift

    public var status: BeneficiaryStatus? { get }

  • The beneficiary account status reason.

    Declaration

    Swift

    public var statusReason: String?

  • The beneficiary’s first name.

    Declaration

    Swift

    public var firstName: String?

  • The beneficiary’s middle name.

    Declaration

    Swift

    public var middleName: String?

  • The beneficiary’s second last name.

    Declaration

    Swift

    public var secondLastName: String?

  • The beneficiary’s last name.

    Declaration

    Swift

    public var lastName: String?

  • Beneficiary date of birth. Optional.

    Declaration

    Swift

    public var dateOfBirth: String?

  • The beneficiary’s phone number. Optional.

    Declaration

    Swift

    public var phoneNumber: String?

  • The beneficiary’s label. Optional.

    Declaration

    Swift

    public var label: String?

  • Three-letter country code (ISO 3166-1 alpha-3). The keys can be mapped from Country if you want type safety.

    Declaration

    Swift

    public var country: String

  • The currency details what currency type is being used for the transaction, using the ISO-4217 format.

    Declaration

    Swift

    public var currencyString: String

  • The currency details what currency type is being used for the transaction, using the ISO-4217 format. Check currencyString if nil.

    Declaration

    Swift

    public var currency: Currency? { get }

  • Beneficiary address model.

    Declaration

    Swift

    public var address: OptionalAddress?

  • The beneficiary’s creation date.

    Declaration

    Swift

    public let created: String

  • The beneficiary’s modification date.

    Declaration

    Swift

    public let updated: String

  • Identifying number used for tax purposes.

    Declaration

    Swift

    public let taxIdLastFour: String?

  • The beneficiary’s id information.

    Declaration

    Swift

    public let idInformation: IdInformation?