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

# Update a Payee's Bank Account

> Change details of a saved bank account. Send only the fields you want to update — anything you leave out is kept as-is. The usual case is filling in a field that's required for a corridor but was missed at creation, such as the IFSC code for an India destination (`ifsc`).

If you send a new `bank_account_number` it must be digits only; it is re-encrypted and only the last four digits are ever returned.



## OpenAPI

````yaml PATCH /v1/platform/payees/bank-accounts/{payee_id}/{bank_account_id}
openapi: 3.1.0
info:
  title: Finogate Platform API v1
  version: 0.1.0
servers:
  - url: https://api-sandbox.finogates.com
    description: Sandbox
  - url: https://api.finogates.com
    description: Production
security: []
tags:
  - name: auth
  - name: users
  - name: payees
  - name: verification
  - name: bank accounts
  - name: card processing
  - name: digital-assets
  - name: international
  - name: fees
  - name: onboarding
  - name: pending-applications
  - name: wallets
  - name: payments
  - name: document mailing
  - name: merchant onboarding
  - name: catalog
  - name: webhooks
  - name: screening
  - name: Platform - File Scanning
  - name: phone-numbers
  - name: sms
  - name: calls
  - name: listings
  - name: Card Transfers
  - name: embed-tokens
paths:
  /v1/platform/payees/bank-accounts/{payee_id}/{bank_account_id}:
    patch:
      tags:
        - payees
      summary: Update a Payee's Bank Account
      description: >-
        Change details of a saved bank account. Send only the fields you want to
        update — anything you leave out is kept as-is. The usual case is filling
        in a field that's required for a corridor but was missed at creation,
        such as the IFSC code for an India destination (`ifsc`).


        If you send a new `bank_account_number` it must be digits only; it is
        re-encrypted and only the last four digits are ever returned.
      operationId: >-
        update_bank_account_v1_platform_payees_bank_accounts__payee_id___bank_account_id__patch
      parameters:
        - name: payee_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Payee Id
        - name: bank_account_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Bank Account Id
        - name: user_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            description: >-
              Optional. The unique ID of the user who owns this payee. Omit to
              look the payee up by its ID within your tenant.
            examples:
              - b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4
            title: User Id
          description: >-
            Optional. The unique ID of the user who owns this payee. Omit to
            look the payee up by its ID within your tenant.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayeeBankAccountUpdate'
            examples:
              rename:
                summary: Rename the account
                value:
                  nickname: Acme — Primary payout account
              backfill_routing_code:
                summary: Backfill a corridor routing code (e.g. India IFSC)
                value:
                  ifsc: SBIN0001234
      responses:
        '200':
          description: The updated bank account (sensitive numbers masked).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse_PayeeBankAccountRead_'
              example:
                status_code: 200
                data:
                  id: f1e2d3c4-b5a6-7890-1234-567890abcdef
                  payee_id: d4e5f6a7-b8c9-0123-4567-890abcdef012
                  nickname: Acme — Primary payout account
                  account_holder_name: Acme Supplier LLC
                  bank_name: Example Bank
                  bank_country: US
                  currency: USD
                  rail_code: ach
                  account_type: checking
                  account_last4: '6789'
                  routing_last4: '0021'
                  status: active
                  created_at: '2025-06-10T18:12:00.000Z'
                  updated_at: '2025-06-12T11:02:17.000Z'
                query_generated_time: 1712847600000
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - _AuthenticatedBearer: []
components:
  schemas:
    PayeeBankAccountUpdate:
      properties:
        nickname:
          anyOf:
            - type: string
              maxLength: 120
            - type: 'null'
          title: Nickname
        account_holder_name:
          anyOf:
            - type: string
              maxLength: 120
            - type: 'null'
          title: Account Holder Name
        bank_name:
          anyOf:
            - type: string
              maxLength: 120
            - type: 'null'
          title: Bank Name
        account_type:
          anyOf:
            - type: string
              maxLength: 30
            - type: 'null'
          title: Account Type
          description: >-
            Account type — "checking"/"savings" for US ACH, or the UniTeller
            code (AHO/CTE/NON).
        bank_account_number:
          anyOf:
            - type: string
              maxLength: 34
              minLength: 4
            - type: 'null'
          title: Bank Account Number
          description: New bank account number (digits only). Re-encrypted on update.
        bank_branch:
          anyOf:
            - type: string
              maxLength: 50
            - type: 'null'
          title: Bank Branch
          description: UniTeller branch / routing code (IFSC, SWIFT/BIC, or CLABE).
        bank_document:
          anyOf:
            - type: string
              maxLength: 100
            - type: 'null'
          title: Bank Document
        payout_branch_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Payout Branch Id
      type: object
      title: PayeeBankAccountUpdate
      description: >-
        Partial update for a saved payee bank account (PATCH semantics).


        Only the fields included in the request body are changed; everything
        else is

        left untouched. The common use is filling in a corridor-required field
        that

        was missed at creation — e.g. the IFSC code for an India destination

        (``bank_branch`` / ``ifsc``). The account number, when supplied, is

        re-encrypted and re-masked exactly as on create.
    CommonResponse_PayeeBankAccountRead_:
      properties:
        status_code:
          type: integer
          title: Status Code
          description: HTTP status code for the response.
        data:
          $ref: '#/components/schemas/PayeeBankAccountRead'
          description: Payload or error details.
        query_generated_time:
          type: integer
          title: Query Generated Time
          description: >-
            UTC timestamp (milliseconds since epoch) when response was
            generated.
      type: object
      required:
        - status_code
        - data
        - query_generated_time
      title: CommonResponse[PayeeBankAccountRead]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PayeeBankAccountRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        payee_id:
          type: string
          format: uuid
          title: Payee Id
        nickname:
          anyOf:
            - type: string
            - type: 'null'
          title: Nickname
        account_holder_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Account Holder Name
        bank_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Bank Name
        bank_country:
          anyOf:
            - type: string
            - type: 'null'
          title: Bank Country
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        rail_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Rail Code
        account_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Account Type
        account_last4:
          anyOf:
            - type: string
            - type: 'null'
          title: Account Last4
        routing_last4:
          anyOf:
            - type: string
            - type: 'null'
          title: Routing Last4
        routing_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Routing Number
        swift_bic:
          anyOf:
            - type: string
            - type: 'null'
          title: Swift Bic
        iban_last4:
          anyOf:
            - type: string
            - type: 'null'
          title: Iban Last4
        bank_branch:
          anyOf:
            - type: string
            - type: 'null'
          title: Bank Branch
        bank_document:
          anyOf:
            - type: string
            - type: 'null'
          title: Bank Document
        payout_branch_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Payout Branch Id
        status:
          type: string
          title: Status
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
        - payee_id
        - status
      title: PayeeBankAccountRead
      description: Bank account returned by the API — last-four digits only.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    _AuthenticatedBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /v1/platform/auth/token

````