> ## 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.

# Manage VBA Status

> Activate or deactivate a Virtual Bank Account



## OpenAPI

````yaml openapi/v3/openapi.json PATCH /pg/vba/{virtual_account_id}/
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: []
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 virtual bank accounts and read collected payments.
  - name: B2B Verification
    description: Verification and post-settlement compliance for B2B payments.
paths:
  /pg/vba/{virtual_account_id}/:
    patch:
      tags:
        - Virtual Bank Accounts
      summary: Manage VBA Status
      description: >-
        Sets the VBA status to `ACTIVE` or `INACTIVE`. A merchant can have more
        than one `ACTIVE` VBA.
      operationId: v3_patch_pg_vba_virtual_account_id_
      parameters:
        - name: virtual_account_id
          in: path
          description: Virtual account ID of the VBA to manage.
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/ApiVersion'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - status
              properties:
                status:
                  type: string
                  enum:
                    - ACTIVE
                    - INACTIVE
                  description: VBA status.
            example:
              status: INACTIVE
      responses:
        '200':
          description: VBA status updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: VBA status updated successfully
                  data:
                    type: object
                    properties:
                      uid:
                        type: string
                        example: VBA5977751432
                      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: INACTIVE
                      remitter_lock_details:
                        type: object
                        nullable: true
                        description: >-
                          The remitter lock on the VBA. `null` when no lock is
                          set.
                        properties:
                          allowed_remitters:
                            type: array
                            items:
                              type: object
                              properties:
                                account_number:
                                  type: string
                                  example: '26291800001191'
                                ifsc:
                                  type: string
                                  example: YESB0000262
                      amount_lock_details:
                        type: object
                        nullable: true
                        description: >-
                          The amount lock on the VBA, in INR. `null` when no
                          lock is set.
                        properties:
                          min_amount:
                            type: number
                            example: 1000
                          max_amount:
                            type: number
                            example: 5000
              example:
                success: true
                message: VBA status updated successfully
                data:
                  uid: VBA5977751432
                  virtual_account_id: '24586202'
                  vba_account_name: Acme Imports
                  vba_bank_code: UTIB
                  vba_account_number: '9461257424586202'
                  vba_ifsc: UTIB0CCH274
                  vba_status: INACTIVE
                  remitter_lock_details: null
                  amount_lock_details: null
        '400':
          description: >-
            `status` is not `ACTIVE` or `INACTIVE`. `error.code` is
            `ERR_SERVICE_ERROR_000`. `ERR_PAYMENT_001` with `details.vba` also
            means your payment gateway does not support virtual accounts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3_ErrorResponse'
              example:
                success: false
                error:
                  code: ERR_SERVICE_ERROR_000
                  message: Payment gateway error
                  details:
                    error: status must be 'ACTIVE' or 'INACTIVE'
        '401':
          description: Your credentials could not be matched to a merchant account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3_ErrorResponse'
        '403':
          description: >-
            Virtual accounts are not enabled on your account, the status of this
            VBA cannot be changed, or, when setting `ACTIVE`, your merchant
            account is suspended or closed (`ERR_MERCHANT_ACCOUNT_003`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3_ErrorResponse'
        '404':
          description: '`ERR_VBA_001`: no virtual account with this ID is yours.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3_ErrorResponse'
              example:
                success: false
                error:
                  code: ERR_VBA_001
                  message: Virtual account not found
                  details:
                    error: VBA not found for this merchant
        '500':
          description: Failed to update VBA status or configuration error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3_ErrorResponse'
        '502':
          description: Payment gateway API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3_ErrorResponse'
      security:
        - clientAuth: []
          clientSecretAuth: []
          merchantAuth: []
components:
  parameters:
    ApiVersion:
      name: X-API-Version
      in: header
      required: false
      description: >-
        Optional. Send `3.0.0`. It is not a credential. The response's
        `X-API-Version` header echoes the value you sent, or your account's
        default version if you send none.
      schema:
        type: string
        enum:
          - 3.0.0
        default: 3.0.0
      example: 3.0.0
  schemas:
    v3_ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          description: Indicates if the request was successful
        error:
          $ref: '#/components/schemas/v3_ErrorDetails'
    v3_ErrorDetails:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Error code (e.g., ERR_ORDER_002)
        message:
          type: string
          description: Error message
        details:
          type: object
          description: Detailed validation error information with field-specific errors
          additionalProperties:
            type: string
            description: Error message for the specific field
  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
    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

````

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