PlaidBankRequest

public struct PlaidBankRequest : Encodable, Sendable

Plaid bank request model.

  • 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. The keys can be mapped from Currency if you want type safety.

    Declaration

    Swift

    public let currency: String

  • The plaid public token.

    Declaration

    Swift

    public let plaidPublicToken: String

  • The plaid account id.

    Declaration

    Swift

    public let plaidAccountId: String

  • This is a value that identifies the bank in your own system. This field MUST be unique per account and it is used to validate against duplicate records.

    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]?

  • Auxiliary constructor.

    Declaration

    Swift

    public init(
    externalId: String,
    country: String,
    currency: String,
    plaidPublicToken: String,
    plaidAccountId: String,
    metadata: [String: CustomValue]? = nil)

    Parameters

    externalId

    This is a value that identifies the bank in your own system. This field MUST be unique per account and it is used to validate against duplicate records.
    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 will be used for transactions, using the ISO-4217 format. The keys can be mapped from Currency if you want type safety.
    plaidPublicToken

    The plaid public token.
    plaidAccountId

    The plaid account id.
    metadata

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