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

# Get Virtual Account by Reference

> Return the account you opened with `reference` on Create Virtual Account. Only your own business's accounts are found.

## Overview

Return the account you opened with `reference` on [Create Virtual Account](https://docs.platnova.com/api-reference/virtual-accounts/create.md). The answer has the same shape as the create response: the customer (`customer_id`, `customer_reference`) and the account in `accounts`, with your `reference` on it.

Only your own business's accounts are found. A reference you never opened an account with answers `404` with `data.code` `virtual_account_not_found`.

This looks up persistent accounts. For a dynamic account opened for an order, use [Verify Payment](https://docs.platnova.com/api-reference/payments/verify.md) with the order reference.


## OpenAPI

````yaml GET /v1/virtual-accounts/by-reference/{reference}
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
  description: >-
    Platnova's Business API: collect payments with hosted checkout, issue
    virtual accounts and cards, send payouts, and receive webhooks.


    # Authentication


    Send your API key in the `X-API-Key` header on every request. Do not send it
    as `Authorization: Bearer`, and do not send a dashboard session token
    alongside it. The `api_key` query parameter is deprecated.


    # Base URLs


    - Live: https://api.platnova.com

    - Sandbox: https://sandbox.api.platnova.co


    # Errors


    Most responses are `{status: boolean, data, error: [], message}`; branch on
    the HTTP status and `data.code`. Validation failures are HTTP 422 `{status:
    "error", message: "Validation failed", errors: {field: [messages]}}`. A
    missing or invalid key is 401 `un-authorized access`. See
    https://docs.platnova.com/errors.
servers:
  - url: https://api.platnova.com
    description: Production server
  - url: https://sandbox.api.platnova.co
    description: Development server
security:
  - apiKeyAuth: []
tags:
  - name: Customer
    description: Create and manage customers
  - name: Virtual Account
    description: Create and manage virtual accounts
  - name: Card
    description: Create and manage cards
  - name: Wallet
    description: List and manage wallets
  - name: Payment
    description: Send and verify payments
  - name: Transaction
    description: List transactions and generate receipts
  - name: Checkout
    description: Create and retrieve checkout sessions
  - name: Payment Link
    description: Create and manage payment links
  - name: Invoice
    description: Create and manage invoices
  - name: Bank
    description: Bank lists and account verification for bank transfers
  - name: Bills
    description: Betting wallet top-ups
  - name: Refunds
paths:
  /v1/virtual-accounts/by-reference/{reference}:
    get:
      tags:
        - Virtual Account
      summary: Get virtual account by reference
      description: >-
        Return the account you opened with `reference` on Create Virtual
        Account. Only your own business's accounts are found.
      operationId: getVirtualAccountByReference
      parameters:
        - name: reference
          in: path
          required: true
          description: The `reference` you sent when creating the account.
          example: LOAN-2026-0042
          schema:
            type: string
      responses:
        '200':
          description: The account(s) opened under this reference
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                  data:
                    type: object
                    properties:
                      customer_id:
                        type: string
                        description: Our customer id.
                      customer_reference:
                        type: string
                        description: Your own id for the customer, when set.
                      reference:
                        type: string
                      currency:
                        type: string
                      email:
                        type: string
                        format: email
                      first_name:
                        type: string
                      last_name:
                        type: string
                      created_on:
                        type: string
                        format: date-time
                      amount_debited:
                        type: number
                      accounts:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: The virtual account's id.
                            account_number:
                              type: string
                            account_name:
                              type: string
                            bank_name:
                              type: string
                            bank_code:
                              type: string
                            ach_routing_number:
                              type: string
                            rtp_routing_number:
                              type: string
                            wire_routing_number:
                              type: string
                            swift_code:
                              type: string
                            bank_address:
                              type: string
                            reference:
                              type: string
                              description: >-
                                Your reference the account was opened under;
                                absent without one.
                  error:
                    type: array
                    items: {}
                  message:
                    type: string
              example:
                status: true
                data:
                  customer_id: 6f1c2b9e-4a7d-4c3e-9b1a-2d5e8f7a6c01
                  customer_reference: CUST-10293
                  reference: ''
                  currency: NGN
                  email: ada@example.com
                  first_name: Ada
                  last_name: Obi
                  created_on: '2026-11-03T10:15:00Z'
                  amount_debited: 0
                  accounts:
                    - id: 9b2f6a10-3c4d-4e5f-8a7b-1c2d3e4f5a6b
                      account_number: '0123456789'
                      account_name: Ada Obi
                      bank_name: Example Bank
                      bank_code: '000000'
                      reference: LOAN-2026-0042
                error: []
                message: operation was successful
        '404':
          description: No account was opened with this reference
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: false
                data:
                  code: virtual_account_not_found
                error: []
                message: No virtual account was opened with this reference.
components:
  schemas:
    Error:
      type: object
      properties:
        status:
          type: boolean
          example: false
        data:
          type: object
          description: Often empty. On coded errors holds `code` and details.
          properties:
            code:
              type: string
              example: request_in_progress
        error:
          type: array
          items:
            type: string
        message:
          type: string
          description: For people; don't parse.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication.

````

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