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

# List VBAs

> Return a paginated list of Virtual Bank Accounts for the merchant, with optional status/provider filters.



## OpenAPI

````yaml GET /pg/vba/
openapi: 3.0.0
info:
  title: Eximpe Payment Gateway API
  description: >-
    API for payment processing and order management through Eximpe payment
    gateway. This specification is for v3 API version.
  license:
    name: Proprietary
  version: 3.0.0
servers:
  - url: https://api-pacb-uat.eximpe.com
    description: Payment Gateway Sandbox URL
security:
  - clientAuth: []
    clientSecretAuth: []
    apiVersionHeader: []
tags:
  - name: Card Tokens
  - name: Merchants
  - name: Orders
  - name: Payment Links
  - name: Payments
  - name: Refunds
  - name: Settlements
  - name: Subscriptions
  - name: Virtual Bank Accounts
    description: Create and manage ICICI virtual accounts and read collected payments.
paths:
  /pg/vba/:
    get:
      tags:
        - Virtual Bank Accounts
      summary: List Virtual Bank Accounts
      description: >-
        Return a paginated list of Virtual Bank Accounts for the authenticated
        merchant or sub-merchant. Supports optional filtering by `vba_status`
        and `vba_provider`, and pagination via `page`.
      operationId: v3_get_pg_vba_list
      parameters:
        - name: vba_status
          in: query
          required: false
          schema:
            type: string
            enum:
              - ACTIVE
              - INACTIVE
          description: Filter by VBA status.
        - name: vba_provider
          in: query
          required: false
          schema:
            type: string
            enum:
              - CASHFREE
              - ICICI
          description: Filter by VBA provider.
        - name: page
          in: query
          required: false
          schema:
            type: integer
          description: Page number for pagination.
      responses:
        '200':
          description: List of virtual bank accounts.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Request processed successfully.
                  data:
                    type: object
                    properties:
                      count:
                        type: integer
                        example: 2
                      page:
                        type: integer
                        example: 1
                      page_size:
                        type: integer
                        example: 250
                      next:
                        type: string
                        nullable: true
                        example: null
                      previous:
                        type: string
                        nullable: true
                        example: null
                      results:
                        type: array
                        items:
                          type: object
                          properties:
                            uid:
                              type: string
                              example: VBA_7d1f9a2b3c
                            virtual_account_id:
                              type: string
                              example: '24586202'
                            vba_account_name:
                              type: string
                              example: Acme Imports
                            vba_bank_code:
                              type: string
                              example: UTIB
                            vba_account_number:
                              type: string
                              example: '9461257424586202'
                            vba_ifsc:
                              type: string
                              example: UTIB0CCH274
                            vba_status:
                              type: string
                              enum:
                                - ACTIVE
                                - INACTIVE
                              example: ACTIVE
                            vba_provider:
                              type: string
                              enum:
                                - CASHFREE
                                - ICICI
                              example: ICICI
              example:
                success: true
                message: Request processed successfully.
                data:
                  count: 2
                  page: 1
                  page_size: 250
                  next: null
                  previous: null
                  results:
                    - uid: VBA_7d1f9a2b3c
                      virtual_account_id: '24586202'
                      vba_account_name: Acme Imports
                      vba_bank_code: UTIB
                      vba_account_number: '9461257424586202'
                      vba_ifsc: UTIB0CCH274
                      vba_status: ACTIVE
                      vba_provider: ICICI
                    - uid: VBA_8e2a0b3c4d
                      virtual_account_id: '24586203'
                      vba_account_name: Acme Imports
                      vba_bank_code: YESB
                      vba_account_number: '9461257424586203'
                      vba_ifsc: YESB0CMSNOC
                      vba_status: INACTIVE
                      vba_provider: CASHFREE
      security:
        - clientAuth: []
          clientSecretAuth: []
          merchantAuth: []
          apiVersionHeader: []
components:
  securitySchemes:
    clientAuth:
      type: apiKey
      name: X-Client-ID
      in: header
      description: >-
        **Client Application ID** - Your unique application identifier used to
        authenticate API requests. You can find your Client ID in the Developer
        Settings section of the merchant dashboard.
      x-displayName: Client ID
      x-example: your-client-id
    clientSecretAuth:
      type: apiKey
      name: X-Client-Secret
      in: header
      description: >-
        **Client Secret Key** - Your secret key used alongside the Client ID for
        secure authentication. Keep this confidential and never expose it in
        client-side code. Available in the Developer Settings section of the
        merchant dashboard.
      x-displayName: Client Secret
      x-example: your-client-secret
    apiVersionHeader:
      type: apiKey
      name: X-API-Version
      in: header
      description: >-
        **API Version** - Specifies which version of the API to use (e.g.,
        '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which
        API version your integration uses. Default version information is
        available in the Developer Settings.
      x-displayName: API Version
      x-example: 3.0.0
    merchantAuth:
      type: apiKey
      name: X-Merchant-ID
      in: header
      description: >-
        **Merchant Identifier** - The unique ID for the merchant account. This
        is required for PSP (Payment Service Provider) merchants who manage
        multiple merchant accounts. You can find merchant IDs in the Merchant
        Management section of the dashboard.
      x-displayName: Merchant ID
      x-example: your-merchant-id

````