External Account

Bank account snapshot for account.external_account.created and account.external_account.updated events. Bank details are masked.

  • id
    Type: string
    required

    External Account ID.

  • created
    Type: stringFormat: date-time

    Time the External Account was added.

  • updated
    Type: stringFormat: date-time

    Time the External Account was last updated.

  • object
    enum
    const:  
    bank_account
    required

    Identifies the resource carried by this event.

  • status
    Type: string

    Status of the External Account.

  • account
    Type: string

    Account that owns the External Account.

  • livemode
    Type: boolean

    Whether the resource belongs to live mode or test mode.

  • country
    Type: string
    min length:  
    2
    max length:  
    2
  • currency
    Type: string | null

    Three-letter currency code.

  • holder_name
    Type: string
  • holder_type
    Type: stringenum
    values
    • individual

      The bank account is held by an individual.

    • company

      The bank account is held by a company.

  • bank_name
    Type: string | null

    Bank name, when available.

  • display_mask
    Type: string

    Masked account details for display.

  • last4
    Type: string

    Last four characters of the account number.

  • default_for_currency
    Type: boolean

    Whether this is the default destination for its currency.

  • revision
    Type: integer

    Revision of the External Account details.

  • settlement_currencies
    Type: array of object

    Currencies available for settlement to this External Account.

    Properties: 4
  • metadata

    Metadata attached to the resource.

    Metadata attached to the resource.

    • propertyName
      additionalPropertyType: string