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

# Get virtual accounts

> Retrieve the list of virtual accounts for a business.



## OpenAPI

````yaml get /v1/virtual-accounts
openapi: 3.1.1
info:
  title: HitPay API
  description: >-
    Accept PayNow, FPX, QRIS, GrabPay, cards, and 40+ payment methods with a
    single API. Production base URL: https://api.hit-pay.com, Sandbox:
    https://api.sandbox.hit-pay.com
  version: '1.0'
servers:
  - url: https://api.hit-pay.com
    description: Production
  - url: https://api.sandbox.hit-pay.com
    description: Sandbox
security: []
paths:
  /v1/virtual-accounts:
    get:
      tags:
        - Virtual Accounts
      summary: Get virtual accounts
      description: >
        Retrieve the list of virtual accounts for a business. Results are
        paginated using cursor-based pagination

        and ordered by creation date (newest first).
      parameters:
        - name: X-BUSINESS-API-KEY
          in: header
          required: true
          style: simple
          explode: false
          schema:
            type: string
            example: b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d
        - name: cursor
          in: query
          schema:
            type:
              - string
              - 'null'
          description: Cursor for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            enum:
              - 5
              - 10
              - 20
              - 25
              - 50
              - 100
            default: 25
          description: Number of results per page
        - name: bank_country
          in: query
          schema:
            type: string
          description: >-
            Only return virtual accounts held in this bank country (two-letter
            lowercase ISO 3166-1 code, e.g. `sg`)
        - name: status
          in: query
          schema:
            type: string
            enum:
              - open
              - closed
          description: >-
            Only return open or closed virtual accounts. A closed account is one
            that has been closed; this is separate from the `status` field in
            the response, which is the provisioning status. Omit to return both.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Virtual account ID
                          example: 9b3f1a2c-1d4e-4f6a-8b2c-7e9d0a1b2c3d
                        name:
                          type: string
                          description: Display name of the virtual account
                          example: Acme Pte Ltd
                        reference:
                          type: string
                          description: >-
                            Virtual account reference issued by the bank. For
                            DBS Singapore this is the 7-digit VA number that
                            forms the tail of `account_number`.
                          example: '1234567'
                        status:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Provisioning status of the virtual account:
                            `pending`, `success`, or `rejected`. `pending` means
                            the bank has acknowledged the request but has not
                            activated the account yet.
                          example: success
                        country:
                          type: string
                          description: >-
                            Two-letter lowercase ISO 3166-1 country code of the
                            business the virtual account belongs to
                          example: sg
                        supported_currencies:
                          type:
                            - array
                            - 'null'
                          items:
                            type: string
                          description: >-
                            Uppercase currency codes that can be received into
                            this virtual account
                          example:
                            - SGD
                            - USD
                        holder_name:
                          type: string
                          description: >-
                            Account holder name, i.e. the registered name of the
                            business
                          example: Acme Pte Ltd
                        account_number:
                          type: string
                          description: >-
                            Full account number to transfer funds to. For DBS
                            Singapore this is the VA prefix and corporate code
                            prepended to `reference`.
                          example: '8854911234567'
                        bank_name:
                          type:
                            - string
                            - 'null'
                          description: Name of the bank holding the virtual account
                          example: DBS Bank
                        bank_swift_code:
                          type:
                            - string
                            - 'null'
                          description: >-
                            SWIFT/BIC code of the bank. `null` for providers
                            that settle without one, such as Philippine accounts
                            on InstaPay and PESONet.
                          example: DBSSSGSG
                        bank_country:
                          type: string
                          description: >-
                            Two-letter lowercase ISO 3166-1 country code of the
                            country the bank account is held in. Can differ from
                            `country`, e.g. a Singapore business can hold an
                            account in `gb`.
                          example: sg
                        bank_attributes:
                          type:
                            - object
                            - 'null'
                          description: >-
                            Bank details for paying into the account. `type`
                            names the account identifier that applies (`local`,
                            `iban`, `sort_code` or `bsb`) and the other keys
                            depend on it. `null` while the bank is still issuing
                            the account.
                          properties:
                            type:
                              type: string
                              example: local
                            account_number:
                              type: string
                              example: '8854911234567'
                            bank_name:
                              type: string
                              example: DBS Bank
                            bank_address:
                              type: string
                            swift_code:
                              type: string
                              example: DBSSSGSG
                            iban:
                              type: string
                            sort_code:
                              type: string
                            bsb:
                              type: string
                            bic:
                              type: string
                            transfer_types:
                              type: array
                              items:
                                type: string
                              example:
                                - FAST
                                - SWIFT
                          additionalProperties: true
                        transfer_types:
                          type: array
                          items:
                            type: string
                          description: >-
                            Transfer rails the virtual account can receive funds
                            over
                          example:
                            - FAST
                            - SWIFT
                        created_at:
                          type: string
                          format: date-time
                          description: >-
                            ISO 8601 timestamp of when the virtual account was
                            created
                          example: '2026-06-08T15:30:10+08:00'
                        updated_at:
                          type: string
                          format: date-time
                          description: >-
                            ISO 8601 timestamp of when the virtual account was
                            last updated
                          example: '2026-06-08T15:30:10+08:00'
                  links:
                    type: object
                    properties:
                      first:
                        type:
                          - string
                          - 'null'
                      last:
                        type:
                          - string
                          - 'null'
                      prev:
                        type:
                          - string
                          - 'null'
                      next:
                        type:
                          - string
                          - 'null'
                  meta:
                    type: object
                    properties:
                      path:
                        type: string
                      per_page:
                        type: integer
                      next_cursor:
                        type:
                          - string
                          - 'null'
                      prev_cursor:
                        type:
                          - string
                          - 'null'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Error message
                  errors:
                    type: array
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Error message
                  errors:
                    type: array

````

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