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

# List All Registered Customer Bank Accounts

> List all bank accounts for a customer with pagination

Use this endpoint to retrieve a paginated list of all bank accounts registered in your SpherePay account. You can optionally filter results by customer ID to fetch only the accounts belonging to a specific customer. Results are returned in descending order of creation time.


## OpenAPI

````yaml openapi/spherepay.yaml GET /v2/bank-account
openapi: 3.0.0
info:
  title: ''
  description: ''
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.spherepay.co
    description: Production
security:
  - bearer: []
tags: []
paths:
  /v2/bank-account:
    get:
      summary: List Bank Accounts
      description: List all bank accounts for a customer with pagination
      parameters:
        - name: page
          required: true
          in: query
          description: 'Page number of the list (default: 1)'
          schema:
            default: '1'
            example: 1
            type: string
        - name: limit
          required: true
          in: query
          description: 'Number of items per page (default: 10)'
          schema:
            default: '10'
            example: 10
            type: string
        - name: customerId
          required: false
          in: query
          description: Filter by customer ID
          schema:
            example: customer_66c4168d418a410eae282b83883bdc39
            type: string
        - name: network
          required: false
          in: query
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankAccountListResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetailsDto'
              examples:
                Bad Request:
                  summary: Bad Request
                  value:
                    status: 400
                    detail: Invalid request parameters
                    code: address/invalid
                    correlationId: 28c61e885c6e5eaa78c1a2183a9b883c
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetailsDto'
              examples:
                Not Found:
                  summary: Not Found
                  value:
                    status: 404
                    detail: Resource not found
                    code: resource/not-found
                    correlationId: 28c61e885c6e5eaa78c1a2183a9b883c
        '422':
          description: Unprocessable Entity - Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetailsDto'
              examples:
                Validation Error:
                  summary: Validation Error
                  value:
                    status: 422
                    detail: Validation failed
                    code: validation/failed
                    correlationId: 28c61e885c6e5eaa78c1a2183a9b883c
                    errors:
                      - detail: Invalid email format
                        pointer: /email
                      - detail: Name is required
                        pointer: /name
components:
  schemas:
    BankAccountListResponseDto:
      type: object
      properties:
        data:
          description: Array of bank account objects
          type: array
          items:
            oneOf:
              - title: USD
                type: object
                properties:
                  id:
                    description: The unique identifier of the bank account.
                    example: bankAccount_ce745ef7f3df4b9a8bff1301ce24b045
                    type: string
                  status:
                    description: The current status of the bank account.
                    example: active
                    type: string
                    enum:
                      - pending
                      - active
                      - inactive
                      - invalid
                    x-enumNames:
                      - Pending
                      - Active
                      - Inactive
                      - Invalid
                  customerId:
                    description: >-
                      The unique identifier of the customer who owns this bank
                      account.
                    example: customer_66c4168d418a410eae282b83883bdc39
                    type: string
                  created:
                    description: The ISO 8601 timestamp when the bank account was created.
                    example: '2025-01-01T00:00:00Z'
                    type: string
                  updated:
                    description: >-
                      The ISO 8601 timestamp when the bank account was last
                      updated.
                    example: '2025-01-01T00:00:00Z'
                    type: string
                  bankName:
                    description: >-
                      The name of the financial institution where the account is
                      held.
                    example: Bank of America
                    type: string
                  accountName:
                    description: A descriptive name for this bank account.
                    example: Checking Account
                    type: string
                  currency:
                    description: The currency of the bank account.
                    example: usd
                    type: string
                    enum:
                      - usd
                  accountDetails:
                    description: >-
                      USD account details. For ACH/Wire: accountNumber,
                      routingNumber, accountType. For SWIFT: accountNumber
                      (masked), bic.
                    oneOf:
                      - type: object
                        properties:
                          accountNumber:
                            description: >-
                              The bank account number for the US bank account
                              (masked, last 4 characters visible). Present when
                              currency is usd.
                            example: '****7890'
                            type: string
                          routingNumber:
                            description: >-
                              The 9-digit ABA routing number (also known as
                              routing transit number) that identifies the US
                              financial institution. Present when currency is
                              usd.
                            example: '021000021'
                            type: string
                          accountType:
                            description: >-
                              The type of US bank account. Present when currency
                              is usd.
                            example: checking
                            type: string
                            enum:
                              - checking
                              - savings
                              - instapay
                              - pesonet
                            x-enumNames:
                              - Checking
                              - Savings
                              - Instapay
                              - Pesonet
                        required:
                          - accountNumber
                          - routingNumber
                          - accountType
                      - type: object
                        properties:
                          accountNumber:
                            description: >-
                              The account number for SWIFT transfers (masked,
                              last 4 characters visible). Present when currency
                              is usd and networks is ["swift"].
                            example: '******7890'
                            type: string
                          bic:
                            description: >-
                              The BIC/SWIFT code of the beneficiary bank.
                              Present when currency is usd and networks is
                              ["swift"].
                            example: DEUTDEFF
                            type: string
                          intermediaryBics:
                            description: >-
                              Ordered list of BIC/SWIFT codes for intermediary
                              correspondent banks, if any were set on this
                              account. Omitted from the response when no
                              intermediary BICs are set.
                            example:
                              - CHASUS33
                            type: array
                            items:
                              type: string
                        required:
                          - accountNumber
                          - bic
                  accountOwner:
                    description: >-
                      Information about the account owner, including their name
                      and relationship to the customer.
                    type: object
                    properties:
                      accountHolderName:
                        description: >-
                          The name of the account holder as it appears on the
                          bank account.
                        example: John Doe
                        type: string
                      relationship:
                        description: The relationship of the account owner to the customer.
                        example: self
                        type: string
                        enum:
                          - self
                          - holding_company
                          - subsidiary_company
                          - branch_office
                          - business_partner
                          - supplier
                          - customer
                          - creditor
                          - debtor
                          - franchisee
                          - unknown
                    required:
                      - accountHolderName
                      - relationship
                  networks:
                    description: >-
                      The payment networks supported by this bank account. For
                      USD ACH/Wire accounts, includes at least one of "ach" or
                      "wire". For USD SWIFT accounts, is exactly ["swift"].
                    example:
                      - wire
                      - ach
                    oneOf:
                      - type: array
                        items:
                          type: string
                          enum:
                            - ach
                            - wire
                      - type: array
                        items:
                          oneOf:
                            - type: string
                              enum:
                                - swift
                required:
                  - id
                  - status
                  - customerId
                  - created
                  - updated
                  - bankName
                  - accountName
                  - currency
                  - accountDetails
                  - accountOwner
                  - networks
              - title: EUR
                type: object
                properties:
                  id:
                    description: The unique identifier of the bank account.
                    example: bankAccount_ce745ef7f3df4b9a8bff1301ce24b045
                    type: string
                  status:
                    description: The current status of the bank account.
                    example: active
                    type: string
                    enum:
                      - pending
                      - active
                      - inactive
                      - invalid
                    x-enumNames:
                      - Pending
                      - Active
                      - Inactive
                      - Invalid
                  customerId:
                    description: >-
                      The unique identifier of the customer who owns this bank
                      account.
                    example: customer_66c4168d418a410eae282b83883bdc39
                    type: string
                  created:
                    description: The ISO 8601 timestamp when the bank account was created.
                    example: '2025-01-01T00:00:00Z'
                    type: string
                  updated:
                    description: >-
                      The ISO 8601 timestamp when the bank account was last
                      updated.
                    example: '2025-01-01T00:00:00Z'
                    type: string
                  bankName:
                    description: >-
                      The name of the financial institution where the account is
                      held.
                    example: Deutsche Bank
                    type: string
                  accountName:
                    description: A descriptive name for this bank account.
                    example: Hauptkonto
                    type: string
                  currency:
                    description: The currency of the bank account.
                    example: eur
                    type: string
                    enum:
                      - eur
                  accountDetails:
                    description: EUR/SEPA account details including iban and bic.
                    type: object
                    properties:
                      iban:
                        description: >-
                          The International Bank Account Number (IBAN) for SEPA
                          transfers (masked). Country code, check digits, and
                          last 4 characters are unmasked. Present when currency
                          is eur.
                        example: GB29****************6819
                        type: string
                      bic:
                        description: >-
                          The Bank Identifier Code (BIC), also known as SWIFT
                          code. Present when currency is eur.
                        example: COBADEFFXXX
                        type: string
                    required:
                      - iban
                      - bic
                  accountOwner:
                    description: >-
                      Information about the account owner, including their name
                      and relationship to the customer.
                    type: object
                    properties:
                      accountHolderName:
                        description: >-
                          The name of the account holder as it appears on the
                          bank account.
                        example: John Doe
                        type: string
                      relationship:
                        description: The relationship of the account owner to the customer.
                        example: self
                        type: string
                        enum:
                          - self
                          - holding_company
                          - subsidiary_company
                          - branch_office
                          - business_partner
                          - supplier
                          - customer
                          - creditor
                          - debtor
                          - franchisee
                          - unknown
                    required:
                      - accountHolderName
                      - relationship
                  networks:
                    description: >-
                      The payment networks supported by this bank account. For
                      EUR accounts, is exactly ["sepa"].
                    example:
                      - sepa
                    type: array
                    items:
                      type: string
                      enum:
                        - sepa
                required:
                  - id
                  - status
                  - customerId
                  - created
                  - updated
                  - bankName
                  - accountName
                  - currency
                  - accountDetails
                  - accountOwner
                  - networks
              - title: BRL
                type: object
                properties:
                  id:
                    description: The unique identifier of the bank account.
                    example: bankAccount_ce745ef7f3df4b9a8bff1301ce24b045
                    type: string
                  status:
                    description: The current status of the bank account.
                    example: active
                    type: string
                    enum:
                      - pending
                      - active
                      - inactive
                      - invalid
                    x-enumNames:
                      - Pending
                      - Active
                      - Inactive
                      - Invalid
                  customerId:
                    description: >-
                      The unique identifier of the customer who owns this bank
                      account.
                    example: customer_66c4168d418a410eae282b83883bdc39
                    type: string
                  created:
                    description: The ISO 8601 timestamp when the bank account was created.
                    example: '2025-01-01T00:00:00Z'
                    type: string
                  updated:
                    description: >-
                      The ISO 8601 timestamp when the bank account was last
                      updated.
                    example: '2025-01-01T00:00:00Z'
                    type: string
                  bankName:
                    description: >-
                      The name of the financial institution where the account is
                      held.
                    example: ItaÃº
                    type: string
                  accountName:
                    description: A descriptive name for this bank account.
                    example: Conta PIX Alice Santos
                    type: string
                  currency:
                    description: The currency of the bank account.
                    example: brl
                    type: string
                    enum:
                      - brl
                  accountDetails:
                    description: BRL/PIX account details including pixKey and pixKeyType.
                    type: object
                    properties:
                      pixKey:
                        description: >-
                          The masked PIX key for Brazilian PIX transfers.
                          Present when currency is brl.
                        example: a*c@g***l.com
                        type: string
                      pixKeyType:
                        description: The type of PIX key. Present when currency is brl.
                        example: email
                        type: string
                        enum:
                          - cpf
                          - cnpj
                          - email
                          - phone
                          - random
                    required:
                      - pixKey
                      - pixKeyType
                  accountOwner:
                    description: >-
                      Information about the account owner, including their name
                      and relationship to the customer.
                    type: object
                    properties:
                      accountHolderName:
                        description: >-
                          The name of the account holder as it appears on the
                          bank account.
                        example: John Doe
                        type: string
                      relationship:
                        description: The relationship of the account owner to the customer.
                        example: self
                        type: string
                        enum:
                          - self
                          - holding_company
                          - subsidiary_company
                          - branch_office
                          - business_partner
                          - supplier
                          - customer
                          - creditor
                          - debtor
                          - franchisee
                          - unknown
                    required:
                      - accountHolderName
                      - relationship
                  networks:
                    description: >-
                      The payment networks supported by this bank account. For
                      BRL accounts, is exactly ["pix"].
                    example:
                      - pix
                    type: array
                    items:
                      type: string
                      enum:
                        - pix
                required:
                  - id
                  - status
                  - customerId
                  - created
                  - updated
                  - bankName
                  - accountName
                  - currency
                  - accountDetails
                  - accountOwner
                  - networks
        pagination:
          type: object
          properties:
            page:
              description: Current page number
              example: 1
              type: number
            limit:
              description: Number of items per page
              example: 10
              type: number
              minimum: 1
              exclusiveMinimum: false
              maximum: 100
              exclusiveMaximum: false
            total:
              description: Total number of items
              example: 1
              type: number
            totalPages:
              description: Total number of pages
              example: 1
              type: number
            hasNext:
              description: Whether there is a next page
              example: false
              type: boolean
            hasPrevious:
              description: Whether there is a previous page
              example: false
              type: boolean
          required:
            - page
            - limit
            - total
            - totalPages
            - hasNext
            - hasPrevious
      required:
        - data
        - pagination
    ProblemDetailsDto:
      type: object
      properties:
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              detail:
                type: string
              pointer:
                type: string
              parameter:
                type: string
              header:
                type: string
            required:
              - detail
        correlationId:
          type: string
      required:
        - status
        - detail
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````