CreateBeneficiaryRequest

public struct CreateBeneficiaryRequest : Encodable, Sendable

Create beneficiary request model.

  • 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 let type: BeneficiaryType

  • Whether the beneficiary is an individual or a business.

    Declaration

    Swift

    public let legalType: BeneficiaryLegalType

  • The business’ name. Required if legalType is .business.

    Declaration

    Swift

    public let businessName: String?

  • The beneficiary’s first name.

    Declaration

    Swift

    public let firstName: String?

  • The beneficiary’s middle name.

    Declaration

    Swift

    public let middleName: String?

  • The beneficiary’s second last name.

    Declaration

    Swift

    public let secondLastName: String?

  • The beneficiary’s last name.

    Declaration

    Swift

    public let lastName: 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 let country: String

  • The currency details what currency type is being used for the transaction, using the ISO-4217 format. The keys can be mapped from Currency if you want type safety.

    Declaration

    Swift

    public let currency: String

  • Beneficiary address model. Optional.

    Declaration

    Swift

    public let address: OptionalAddress?

  • Beneficiary date of birth. Optional.

    Declaration

    Swift

    public let dateOfBirth: String?

  • The beneficiary’s phone number. Optional.

    Declaration

    Swift

    public let phoneNumber: String?

  • The beneficiary’s label. Optional.

    Declaration

    Swift

    public let label: String?

  • Identifying number used for tax purposes.

    Declaration

    Swift

    public let taxId: String?

  • The beneficiary’s id information.

    Declaration

    Swift

    public let idInformation: IdInformation?

  • Auxiliary constructor.

    Declaration

    Swift

    public init(externalId: String,
            type: BeneficiaryType,
            country: String,
            currency: String,
            firstName: String? = nil,
            middleName: String? = nil,
            lastName: String? = nil,
            secondLastName: String? = nil,
            legalType: BeneficiaryLegalType = .individual,
            businessName: String? = nil,
            address: OptionalAddress? = nil,
            dateOfBirth: String? = nil,
            phoneNumber: String? = nil,
            label: String? = nil,
            taxId: String? = nil,
            idInformation: IdInformation? = nil)

    Parameters

    externalId

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

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

    The beneficiary’s first name. Optional if legalType is not .individual.
    lastName

    The beneficiary’s last name. Optional if legalType is not .individual.
    country

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

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

    The beneficiary’s middle name. Optional.
    secondLastName

    The beneficiary’s second last name. Optional.
    legalType

    Whether the beneficiary is an individual or a business.
    businessName

    The business’ name. Optional if legalType is not .business.
    address

    Beneficiary address model. Optional.
    dateOfBirth

    Beneficiary date of birth. Optional.
    phoneNumber

    The beneficiary’s phone number. Optional.
    label

    The beneficiary’s label. Optional.
    taxId

    Identifying number used for tax purposes. Optional.
    idInformation

    The beneficiary’s id information. Optional.