Skip to main content
GET
/
virtual-accounts
cURL
curl --request GET \
  --url https://dev-api.hyperail.io/api/v1/virtual-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'x-service-source: <x-service-source>'
[
  {
    "id": "c1fba25a-a36b-479c-b17d-64dbaf3ba32c",
    "accountNumber": "7706438396",
    "accountName": "Quantum Technologies",
    "bankName": "Testbank MFB",
    "mode": "live",
    "lifeCycle": "temporary"
  }
]

Authorizations

​
Authorization
string
header
required

API key authentication using Bearer token

Headers

​
x-service-source
string
default:HyperRails
required

Identifies the calling service

Example:

"HyperRails"

Query Parameters

​
accountNumber
string
required

This filters by the account number created for the virtual accounts.

Response

A JSON array of dynamic details objects.

​
id
string<uuid>
Example:

"c1fba25a-a36b-479c-b17d-64dbaf3ba32c"

​
accountNumber
string
Example:

"7706438396"

​
accountName
string
Example:

"Quantum Technologies"

​
bankName
string
Example:

"Testbank MFB"

​
mode
enum<string>
Available options:
live,
test
Example:

"live"

​
lifeCycle
string
Example:

"temporary"