Search Virtual Account

POST

/api/v0/merchant-virtual-account/search

Use this API to search and retrieve a list of virtual accounts based on filter criteria such as customer ID, virtual account number, status, amount range, and date ranges. Supports pagination to control the number of records returned.

Request

Query Params

Header Params

Body Params application/jsonRequired

Example

{
  "customerId": "string",
  "customerReferenceId": "CUST7625367",
  "closedByFrom": "2026-01-01 00:00:00",
  "closedByTo": "2026-12-31 23:59:59",
  "virtualAccountStatus": "ACTIVE",
  "amountPaidFrom": 100.00,
  "amountPaidTo": 10000.00,
  "virtualAccountNumber": "NBS123BQ89S4VYP52Z",
  "createdOnFrom": "2026-01-01 00:00:00",
  "createdOnTo": "2026-12-31 23:59:59"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://olympus-pg-uat.enkash.in/api/v0/merchant-virtual-account/search?offset=0&limit=50&orderBy=id&direction=ASC' \
--header 'Authorization: Bearer jIR6lhjFvimVkjNUMEhPWpsnCiI' \
--header 'Content-Type: application/json' \
--data '{
  "customerId": "string",
  "customerReferenceId": "CUST7625367",
  "closedByFrom": "2026-01-01 00:00:00",
  "closedByTo": "2026-12-31 23:59:59",
  "virtualAccountStatus": "ACTIVE",
  "amountPaidFrom": 100.00,
  "amountPaidTo": 10000.00,
  "virtualAccountNumber": "NBS123BQ89S4VYP52Z",
  "createdOnFrom": "2026-01-01 00:00:00",
  "createdOnTo": "2026-12-31 23:59:59"
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
  "response_code": 0,
  "response_message": "SUCCESS",
  "payload": {
    "recordsCount": 42,
    "data": [
      {
        "virtualAccountId": "va_abc123",
        "merchantDetailId": "mdt_abc123",
        "customerId": "cust_001",
        "customerName": "John Doe",
        "customerEmail": "john@example.com",
        "customerPhone": "9876543210",
        "virtualAccountNumber": "VA00001234",
        "virtualAccountIfscCode": "RATN0VAAPIS",
        "bankName": "RBL Bank",
        "customerAccountNumber": "9876543210123",
        "customerUpiHandle": "john@upi",
        "customerIfscCode": "SBIN0001234",
        "status": "ACTIVE",
        "closedOn": "2026-06-01 23:59:59",
        "description": "Monthly rent",
        "amountPaid": 3000.00,
        "notes": {
          "key1": "value1"
        },
        "expectedAmount": 5000.00
      }
    ]
  }
}

Modified at 2026-06-03 05:26:06

View Virtual Account by Account Number

Search Transactions