API Reference
Virtual Accounts
Get all virtual accounts [GET]

Get all virtual accounts


https://sandboxapi.onbrails.com/api/v1/virtual-accounts (opens in a new tab)

Get all virtual accounts

Query Params

ParametertypeRequired
order
String Defaults to ASC
string
pageint32
take
The number of users to return
string

Request

Get all virtual accounts [GET]
curl --request GET \
   --url 'https://sandboxapi.onbrails.com/api/v1/virtual-accounts?order=ASC' \
   --header 'Authorization: Bearer API-KEY' \
   --header 'accept: application/json'

Responses

🟢 200 - Result example
{
  "status": true,
  "message": "Virtual accounts retrieved successfully",
  "data": {
      "virtualAccounts": [
          {
             "id": "f8d4c37d-0292-44b6-ab72-9d1fb7a4ba90",
              "createdAt": "2024-01-31T13:33:17.998Z",
              "updatedAt": "2024-01-31T13:33:17.998Z",
              "customerId": "c5da1833-87bb-4ad9-b1e7-ee41f98983",
              "accountName": "BRAILS_TESTING / JOE DOE",
              "reference": "o1WPNZFmUDZLjDD",
              "bankName": "SafeHaven Microfinance Bank",
              "accountNumber": "8010664155",
              "bank": "safehaven"
          }
      ],
      "meta": {
          "page": 1,
          "take": 10,
          "itemCount": 1,
          "pageCount": 1,
          "hasPreviousPage": false,
          "hasNextPage": false
      }
  }
}