ExternalAccountCollection

  • items
    Type: array object[] · External Account[]
    required
    • default_for_currency
      Type: boolean

      When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.

    • external_account
      • object
        Discriminator
        enum
        const:  
        bank_account
        required
        values
        • bank_account
      • country
        Type: string
        min length:  
        2
        max length:  
        2
        required
      • account_number
        Type: string | null

        A masked representation of the bank account number. For IBAN accounts, this contains a masked IBAN suitable for display. The full account number is never returned after creation.

      • bank_name
        Type: string | null
      • currency
        Type: string | null

        Optional merchant-declared currency hint captured at attach time.

      • holder_name
        Type: string
      • holder_type
        Type: stringenum
        values
        • individual
        • company
      • id
        Type: string
      • last4
        Type: string | null

        The last four characters of the bank account number, used for display and reconciliation.

      • routing_number
        Type: string | null

        The bank routing identifier, when available. For IBAN accounts, this is typically the BIC/SWIFT code. For local bank account schemes, this may be a routing number, sort code, institution number, or equivalent clearing code.

    • metadata

      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

      • propertyName
        Type: string
  • last_key
    Type: string | null
    required