> ## Documentation Index
> Fetch the complete documentation index at: https://docs.finta.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update an account

> Update an account. Requires Storage Mode. A manual account's name, type, currency, mask, balance, or liability data can change; updating the balance records a balance-history snapshot for today. A bank-synced account can only be renamed: send `name` alone, or `name: null` to go back to the bank's name (`institutionAccountName`). Syncs never overwrite the new name. Sending any other field for a synced account returns 400 and saves nothing.



## OpenAPI

````yaml /api/v2/openapi.json patch /accounts/{accountId}
openapi: 3.0.3
info:
  title: Finta API v2
  version: 2.0.0
  description: >-
    DB-backed Finta API for users with storage mode enabled. Requires an API key
    or an OAuth access token, and an active subscription or free trial.


    ## Rate limits


    Rate limits are enforced per user based on subscription plan, separately
    from MCP. The free trial gets Standard limits, or Pro limits if you're
    trialing Pro:


    | Plan | Per minute | Per day |

    | --- | --- | --- |

    | Standard | 20 requests | 500 requests |

    | Pro | 60 requests | 2,000 requests |


    When a limit is exceeded, the API returns HTTP 429 with `error.code`
    `RATE_LIMITED` and a human-readable `message`. A `Retry-After` response
    header is included with the number of seconds until the window resets.
servers:
  - url: https://api.finta.io/v2
    description: Production server
security:
  - bearerAuth: []
tags:
  - name: Me
    description: Authenticated user
  - name: Feedback
    description: Bug reports, unclear docs, confusing errors and feature requests
  - name: Health
    description: Service health
  - name: Bank Connections
    description: Bank connection resources
  - name: Accounts
    description: Account and balance history resources
  - name: Investments
    description: Securities, holdings, and investment transaction resources
  - name: Transactions
    description: Transaction resources
  - name: Categories
    description: Transaction category resources
  - name: Category Groups
    description: Category group resources
  - name: Rules
    description: Transaction rule resources
  - name: Budgets
    description: Budget plans, budgets, and budget status
paths:
  /accounts/{accountId}:
    patch:
      tags:
        - Accounts
      summary: Update an account
      description: >-
        Update an account. Requires Storage Mode. A manual account's name, type,
        currency, mask, balance, or liability data can change; updating the
        balance records a balance-history snapshot for today. A bank-synced
        account can only be renamed: send `name` alone, or `name: null` to go
        back to the bank's name (`institutionAccountName`). Syncs never
        overwrite the new name. Sending any other field for a synced account
        returns 400 and saves nothing.
      operationId: updateAccountV2
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Finta bank account ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManualAccountUpdateRequest'
      responses:
        '200':
          description: Updated account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountResponse'
        '400':
          description: >-
            Invalid request body, a field other than `name` for a bank-synced
            account, or `name: null` before Finta has read the bank's name.
            Nothing is saved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '403':
          description: Storage mode required or subscription inactive
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Account not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          $ref: '#/components/responses/RateLimitedResponse'
components:
  schemas:
    ManualAccountUpdateRequest:
      type: object
      description: >-
        At least one field must be provided. Pass `null` to clear a nullable
        field. A bank-synced account accepts only `name`.
      minProperties: 1
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 120
          nullable: true
          description: >-
            New display name. On a bank-synced account, `null` puts back the
            bank's name (`institutionAccountName`); a manual account needs a
            name.
        type:
          type: string
          minLength: 1
          maxLength: 100
          nullable: true
        subtype:
          type: string
          minLength: 1
          maxLength: 100
          nullable: true
        mask:
          type: string
          minLength: 1
          maxLength: 100
          nullable: true
        currency:
          type: string
          minLength: 1
          maxLength: 10
        currentBalance:
          type: number
          nullable: true
        availableBalance:
          type: number
          nullable: true
        liability:
          $ref: '#/components/schemas/AccountLiability'
    AccountResponse:
      type: object
      required:
        - account
      properties:
        account:
          $ref: '#/components/schemas/AccountSummary'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: STORAGE_MODE_REQUIRED
            message:
              type: string
    UnauthorizedResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          example: Missing or invalid Authorization header
    AccountLiability:
      type: object
      nullable: true
      description: >-
        Liability detail for `credit`, `student`, or `mortgage` accounts; `null`
        for non-liability accounts. Fields not relevant to the liability type
        are `null`. The same shape is accepted when creating or updating a
        manual account.
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - credit
            - student
            - mortgage
        minimumPaymentAmount:
          type: number
          nullable: true
        nextPaymentDueDate:
          type: string
          format: date
          nullable: true
        lastPaymentAmount:
          type: number
          nullable: true
        lastPaymentDate:
          type: string
          format: date
          nullable: true
        interestRate:
          type: number
          nullable: true
        isOverdue:
          type: boolean
          nullable: true
        lastStatementBalance:
          type: number
          nullable: true
          description: Credit accounts only.
        aprs:
          type: array
          description: Credit accounts only.
          items:
            type: object
            required:
              - aprType
              - aprPercentage
            properties:
              aprType:
                type: string
              aprPercentage:
                type: number
              balanceSubjectToApr:
                type: number
                nullable: true
              interestChargeAmount:
                type: number
                nullable: true
        loanName:
          type: string
          nullable: true
          description: Student accounts only.
        loanStatus:
          type: object
          nullable: true
          description: Student accounts only.
          properties:
            type:
              type: string
              nullable: true
            endDate:
              type: string
              format: date
              nullable: true
        repaymentPlan:
          type: object
          nullable: true
          description: Student accounts only.
          properties:
            type:
              type: string
              nullable: true
            description:
              type: string
              nullable: true
        pslfStatus:
          type: object
          nullable: true
          description: Student accounts only.
          properties:
            paymentsRemaining:
              type: number
              nullable: true
            paymentsMade:
              type: number
              nullable: true
            estimatedEligibilityDate:
              type: string
              format: date
              nullable: true
        originationDate:
          type: string
          format: date
          nullable: true
          description: Student and mortgage accounts.
        originationPrincipalAmount:
          type: number
          nullable: true
          description: Student and mortgage accounts.
        expectedPayoffDate:
          type: string
          format: date
          nullable: true
          description: Student accounts only.
        outstandingInterestAmount:
          type: number
          nullable: true
          description: Student accounts only.
        ytdInterestPaid:
          type: number
          nullable: true
          description: Student and mortgage accounts.
        ytdPrincipalPaid:
          type: number
          nullable: true
          description: Student and mortgage accounts.
        interestRateType:
          type: string
          enum:
            - fixed
            - variable
          nullable: true
          description: Mortgage accounts only.
        nextMonthlyPayment:
          type: number
          nullable: true
          description: Mortgage accounts only.
        escrowBalance:
          type: number
          nullable: true
          description: Mortgage accounts only.
        hasPmi:
          type: boolean
          nullable: true
          description: Mortgage accounts only.
        hasPrepaymentPenalty:
          type: boolean
          nullable: true
          description: Mortgage accounts only.
        propertyAddress:
          type: object
          nullable: true
          description: Mortgage accounts only.
          properties:
            street:
              type: string
              nullable: true
            city:
              type: string
              nullable: true
            region:
              type: string
              nullable: true
            postalCode:
              type: string
              nullable: true
            country:
              type: string
              nullable: true
        loanTypeDescription:
          type: string
          nullable: true
          description: Mortgage accounts only.
        maturityDate:
          type: string
          format: date
          nullable: true
          description: Mortgage accounts only.
        pastDueAmount:
          type: number
          nullable: true
          description: Mortgage accounts only.
    AccountSummary:
      type: object
      required:
        - id
        - providerAccountId
        - bankConnectionId
        - bankConnectionStatus
        - provider
        - institutionName
        - name
        - mask
        - type
        - subtype
        - currency
        - currentBalance
        - availableBalance
        - balanceAsOf
        - status
        - closedAt
        - liability
      properties:
        id:
          type: string
          format: uuid
        providerAccountId:
          type: string
        bankConnectionId:
          type: string
          format: uuid
        bankConnectionStatus:
          type: string
          enum:
            - active
            - error
            - disabled
        provider:
          type: string
          example: plaid
        institutionName:
          type: string
          nullable: true
        name:
          type: string
          description: >-
            Display name. The user's own name when they renamed the account;
            syncs never overwrite it.
        institutionAccountName:
          type: string
          description: >-
            The bank's current name for the account. Omitted for manual accounts
            and until a sync reads it.
        mask:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
        subtype:
          type: string
          nullable: true
        currency:
          type: string
          nullable: true
        currentBalance:
          type: number
          nullable: true
        availableBalance:
          type: number
          nullable: true
        balanceAsOf:
          type: string
          format: date-time
          nullable: true
        status:
          type: string
          enum:
            - active
            - closed
            - disconnected
        closedAt:
          type: string
          format: date-time
          nullable: true
        liability:
          $ref: '#/components/schemas/AccountLiability'
  responses:
    RateLimitedResponse:
      description: Rate limit exceeded
      headers:
        Retry-After:
          description: Seconds until the rate-limit window resets
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: RATE_LIMITED
              message: Per-minute rate limit exceeded (standard plan)
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Finta API key from API settings, or an OAuth access token issued to an
        authorized app. Send either as `Authorization: Bearer <token>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.