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

# List external accounts

> List all external accounts for a counter party. Supports cursor-based pagination and filtering by status, transfer type, and currency.



## OpenAPI

````yaml https://production.hifi.com/api/v3/openapi.json get /v3/users/{userId}/counter-parties/{counterPartyId}/external-accounts
openapi: 3.0.0
info:
  title: Hifi API
  version: 3.0.0
  description: API documentation for HIFI
servers:
  - url: https://production.hifi.com
    description: Production server
  - url: https://sandbox.hifi.com
    description: Sandbox server
security:
  - bearerAuth: []
tags:
  - name: Common
    description: Common endpoints
  - name: User
    description: User endpoints
  - name: Counter Party
    description: Counter party endpoints
  - name: Crypto Transfer
    description: Crypto transfer and batch transfer endpoints
  - name: Wallet
    description: Wallet and wallet offer endpoints
  - name: External Account
    description: External bank account endpoints (under a counter party)
  - name: External Wallet
    description: External wallet endpoints (under a counter party)
  - name: External Card
    description: External card endpoints (under a counter party)
  - name: Token Swap
    description: Token swap endpoints
  - name: Bridge
    description: Bridge endpoints
  - name: Virtual Account
    description: Virtual account endpoints
  - name: Compliance
    description: Compliance and compliance link endpoints
  - name: Webhook Endpoint
    description: Webhook endpoint endpoints
  - name: File
    description: File upload endpoints
  - name: Onramp
    description: Onramp (fiat to crypto) endpoints
  - name: Offramp
    description: Offramp (crypto to fiat) endpoints
  - name: Orchestration Address
    description: Orchestration (liquidation) address endpoints
  - name: KYC Link
    description: Hosted and custom KYC/KYB link endpoints
  - name: Transfer Approval
    description: Transfer approval endpoints
  - name: Corridor
    description: Supported fiat/crypto transfer corridor endpoints
  - name: Migration
    description: v2-to-v3 ID mapping endpoints
paths:
  /v3/users/{userId}/counter-parties/{counterPartyId}/external-accounts:
    get:
      tags:
        - External Account
      summary: List external accounts
      description: >-
        List all external accounts for a counter party. Supports cursor-based
        pagination and filtering by status, transfer type, and currency.
      operationId: v3ListExternalAccounts
      parameters:
        - $ref: '#/components/parameters/UserIdPathParameter'
        - $ref: '#/components/parameters/CounterPartyIdPathParameter'
        - $ref: '#/components/parameters/LimitParameter'
        - $ref: '#/components/parameters/StartingAfterParameter'
        - $ref: '#/components/parameters/EndingBeforeParameter'
        - $ref: '#/components/parameters/ExternalAccountStatusQueryParameter'
        - $ref: '#/components/parameters/ExternalAccountTransferTypeQueryParameter'
        - $ref: '#/components/parameters/ExternalAccountCurrencyQueryParameter'
      responses:
        '200':
          $ref: '#/components/responses/ListExternalAccountsResponse'
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
components:
  parameters:
    UserIdPathParameter:
      name: userId
      in: path
      schema:
        type: string
        pattern: ^user_[A-Za-z0-9]+$
      description: ID of the user.
      required: true
    CounterPartyIdPathParameter:
      name: counterPartyId
      in: path
      required: true
      schema:
        type: string
      description: Public ID of the counter party (prefixed with `cpty_`)
      example: cpty_7bV1aLcs3Kf9dQ2mNpXwZ
    LimitParameter:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
      description: default to 10, maximum to 100
      required: false
    StartingAfterParameter:
      name: startingAfter
      in: query
      schema:
        type: string
      description: Return records after this cursor.
      required: false
    EndingBeforeParameter:
      name: endingBefore
      in: query
      schema:
        type: string
      description: Return records before this cursor.
      required: false
    ExternalAccountStatusQueryParameter:
      name: status
      in: query
      required: false
      schema:
        type: string
        enum:
          - ACTIVE
          - INACTIVE
      description: Filter external accounts by status.
    ExternalAccountTransferTypeQueryParameter:
      name: transferType
      in: query
      required: false
      schema:
        type: string
        enum:
          - ACH
          - WIRE
          - SWIFT
          - RTP
          - PIX
          - SPEI
          - CHATS
          - FPS
          - CIPS
          - SEPA
          - INSTAPAY
          - PESONET
          - NEQUI
          - BANK
      description: Filter external accounts by transfer type.
    ExternalAccountCurrencyQueryParameter:
      name: currency
      in: query
      required: false
      schema:
        type: string
        enum:
          - USD
          - EUR
          - BRL
          - NGN
          - KES
          - TZS
          - UGX
          - BWP
          - XAF
          - MWK
          - RWF
          - ZMW
          - XOF
          - ZAR
          - MXN
          - PHP
          - AED
          - HKD
          - CNY
          - COP
          - ARS
          - SGD
          - GBP
      description: Filter external accounts by currency.
  responses:
    ListExternalAccountsResponse:
      description: A cursor-paginated list of external accounts.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ExternalAccountListObject'
          example:
            data:
              - id: extacct_9aB0xY4mNpXwZ7bV1aLdt
                userId: usr_3Kf9dQ2mNpXwZ7bV1aLcs
                counterPartyId: cpty_7dLpR2mNpXwZ7bV1aQz3x
                accountNumber: '****6789'
                routingNumber: '021000021'
                accountType: CHECKING
                bankName: Chase Bank
                bankAddress:
                  addressLine1: 123 Main Street
                  city: New York
                  stateProvinceRegion: NY
                  postalCode: '10001'
                  country: USA
                currency: USD
                transferType: ACH
                status: ACTIVE
                createdAt: '2026-07-01T10:30:00.000Z'
                updatedAt: '2026-07-01T10:30:00.000Z'
            pagination:
              hasMore: false
              startCursor: extacct_9aB0xY4mNpXwZ7bV1aLdt
              endCursor: extacct_9aB0xY4mNpXwZ7bV1aLdt
    BadRequestResponse:
      description: Bad Request — the request was malformed or failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            type: VALIDATION_ERROR
            message: One or more fields are invalid or missing.
            fields:
              - code: invalid_value
                message: Must be a valid email address
                field: email
    UnauthorizedResponse:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Unauthorized'
    InternalServerErrorResponse:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
  schemas:
    ExternalAccountListObject:
      type: object
      description: Cursor-paginated list of external accounts.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ExternalAccountObject'
        pagination:
          $ref: '#/components/schemas/Pagination'
    ApiError:
      type: object
      description: >-
        Standard v3 error shape, returned by validation failures and
        business-logic errors alike.
      properties:
        type:
          type: string
          description: >-
            Machine-readable error type, e.g. VALIDATION_ERROR,
            ACTION_NOT_ALLOWED, RESOURCE_CONFLICT.
          example: VALIDATION_ERROR
        message:
          type: string
          description: Human-readable error message.
          example: One or more fields are invalid or missing.
        fields:
          type: array
          description: >-
            Present on field-level validation errors. One entry per problem
            field.
          items:
            type: object
            properties:
              code:
                type: string
                description: Error code related to the field issue.
              message:
                type: string
                description: Error message for the specific issue.
              field:
                type: string
                description: The name of the field that has an issue.
    Unauthorized:
      type: object
      properties:
        type:
          type: string
          description: Unauthorized enum
          example: UNAUTHORIZED
        message:
          type: string
          description: Unauthorized message
          example: Authentication required
    InternalServerError:
      type: object
      properties:
        type:
          type: string
          example: INTERNAL_SERVER_ERROR
          description: Internal server error enum
        message:
          type: string
          example: An internal server error occurred
          description: Internal server error message
    ExternalAccountObject:
      type: object
      description: An external account.
      properties:
        id:
          type: string
          description: Public ID of the external account (prefixed with `extacct_`).
          example: extacct_9aB0xY4mNpXwZ7bV1aLdt
        userId:
          type: string
          description: >-
            Public ID of the user this account belongs to (prefixed with
            `usr_`).
          example: usr_3Kf9dQ2mNpXwZ7bV1aLcs
        counterPartyId:
          type: string
          description: >-
            Public ID of the counter party this account belongs to (prefixed
            with `cpty_`).
          example: cpty_7dLpR2mNpXwZ7bV1aQz3x
        accountNumber:
          type: string
          description: Masked bank account number.
          example: '****6789'
        routingNumber:
          type: string
          description: ABA routing number.
          example: '021000021'
        accountType:
          type: string
          enum:
            - CHECKING
            - SAVINGS
          example: CHECKING
        iban:
          type: string
          description: Masked IBAN.
          example: '****6789'
        swiftCode:
          type: string
          description: SWIFT/BIC code.
          example: DEUTDEFF
        sortCode:
          type: string
          description: Sort code.
          example: '123456'
        pixKey:
          type: string
          description: Masked PIX key (EVP format).
          example: '****4000'
        phoneNumber:
          type: string
          description: Masked phone number.
          example: +57*****4567
        email:
          type: string
          description: Masked email (PIX key, Brazil only).
          example: j***e@e*****e.com
        cpf:
          type: string
          description: Masked CPF (PIX key, Brazil only).
          example: '****8901'
        cnpj:
          type: string
          description: Masked CNPJ (PIX key, Brazil only).
          example: '****1234'
        bankName:
          type: string
          example: Chase Bank
        bankAddress:
          $ref: '#/components/schemas/ExternalAccountBankAddress'
        currency:
          type: string
          enum:
            - USD
            - EUR
            - BRL
            - NGN
            - KES
            - TZS
            - UGX
            - BWP
            - XAF
            - MWK
            - RWF
            - ZMW
            - XOF
            - ZAR
            - MXN
            - PHP
            - AED
            - HKD
            - CNY
            - COP
            - ARS
            - SGD
            - GBP
          example: USD
        transferType:
          type: string
          enum:
            - ACH
            - WIRE
            - SWIFT
            - RTP
            - PIX
            - SPEI
            - CHATS
            - FPS
            - CIPS
            - SEPA
            - INSTAPAY
            - PESONET
            - NEQUI
            - BANK
          example: ACH
        fpsId:
          type: string
          description: Masked Faster Payment System identifier.
          example: '****6789'
        clabe:
          type: string
          description: Masked CLABE number.
          example: '****9719'
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
          example: ACTIVE
        createdAt:
          type: string
          format: date-time
          example: '2026-07-01T10:30:00.000Z'
        updatedAt:
          type: string
          format: date-time
          example: '2026-07-01T10:30:00.000Z'
    Pagination:
      type: object
      properties:
        hasMore:
          type: boolean
        startCursor:
          type: string
          nullable: true
        endCursor:
          type: string
          nullable: true
      required:
        - hasMore
        - startCursor
        - endCursor
    ExternalAccountBankAddress:
      type: object
      description: Address of the beneficiary bank.
      required:
        - addressLine1
        - city
        - stateProvinceRegion
        - postalCode
        - country
      properties:
        addressLine1:
          type: string
          description: Primary address line.
          example: 123 Main Street
        addressLine2:
          type: string
          description: Secondary address line (apartment, suite, etc.).
          example: Suite 100
        city:
          type: string
          description: City name.
          example: New York
        stateProvinceRegion:
          type: string
          maxLength: 10
          description: State, province, or region.
          example: NY
        postalCode:
          type: string
          description: Postal or ZIP code.
          example: '10001'
        country:
          type: string
          description: ISO 3166-1 alpha-3 country code.
          example: USA
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````