Bank

public struct Bank : Codable, Sendable

The bank model.

  • The unique token for this bank. This is how you will identify this bank in the future throughout the API.

    Declaration

    Swift

    public let paymentMethodUuid: String

  • The account uuid.

    Declaration

    Swift

    public let accountUuid: String?

  • Status of the bank account.

    Declaration

    Swift

    public let statusString: String

  • Status of the bank account. Check statusString if nil.

    Declaration

    Swift

    public var status: BankStatus? { get }

  • The status reason of the bank account.

    Declaration

    Swift

    public let statusReasonString: String?

  • The status reason of the bank account. Check statusReasonString if nil.

    Declaration

    Swift

    public var statusReason: PaymentMethodStatusReason? { get }

  • Type of the bank account.

    Declaration

    Swift

    public let typeString: String

  • Type of the bank account. Check typeString if nil.

    Declaration

    Swift

    public var type: BankType? { get }

  • Last four digits.

    Declaration

    Swift

    public let lastFour: 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 will be used for transactions, using the ISO-4217 format.

    Declaration

    Swift

    public let currencyString: String

  • The currency details what currency type will be used for transactions, using the ISO-4217 format. Check currencyString if nil.

    Declaration

    Swift

    public var currency: Currency? { get }

  • Indicates if a bank account is linked from Plaid.

    Declaration

    Swift

    public let isPlaid: Bool

  • Types of transactions supported by this bank account.

    Declaration

    Swift

    public let flags: BankFlags?

  • The bank account details need to be one of the structures.

    Declaration

    Swift

    public let bankAccountDetails: BankAccountDetails

  • Status fail reason.

    Declaration

    Swift

    public let failReason: String?

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

    Declaration

    Swift

    public let externalId: String

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

    Declaration

    Swift

    public let metadata: [String : CustomValue]?

  • The bank’s token creation date.

    Declaration

    Swift

    public let createdAt: String

  • The bank’s modification date.

    Declaration

    Swift

    public let updatedAt: String