Get Virtual Account Details
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId} \
--header 'x-api-key: <api-key>'import requests
url = "https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const url = 'https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}';
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_bodyimport Foundation
let url = URL(string: "https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["x-api-key": "<api-key>"]
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))val client = OkHttpClient()
val request = Request.Builder()
.url("https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}")
.get()
.addHeader("x-api-key", "<api-key>")
.build()
val response = client.newCall(request).execute()falsepackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"message": "virtual account fetched successfully",
"status": "success",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phoneNumber": "<string>",
"bvn": "<string>",
"reference": "<string>",
"account": {
"name": "<string>",
"bankName": "<string>",
"sortCode": "<string>",
"number": "<string>"
},
"status": "<string>",
"currency": "<string>",
"country": "<string>",
"isPermanent": true,
"expiryTime": 123,
"created": "2023-11-07T05:31:56Z",
"expired": "2023-11-07T05:31:56Z"
}
}{
"message": "Invalid API key",
"status": "failed"
}{
"message": "Access denied: IP address not whitelisted",
"status": "failed"
}{
"message": "Virtual account not found",
"status": "failed"
}Virtual Account
Get Virtual Account
Retrieves the details of a specific virtual account by its unique identifier.
GET
/
v1
/
virtual-account
/
{VirtualAccountId}
Get Virtual Account Details
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId} \
--header 'x-api-key: <api-key>'import requests
url = "https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const url = 'https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}';
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_bodyimport Foundation
let url = URL(string: "https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["x-api-key": "<api-key>"]
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))val client = OkHttpClient()
val request = Request.Builder()
.url("https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}")
.get()
.addHeader("x-api-key", "<api-key>")
.build()
val response = client.newCall(request).execute()falsepackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"message": "virtual account fetched successfully",
"status": "success",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phoneNumber": "<string>",
"bvn": "<string>",
"reference": "<string>",
"account": {
"name": "<string>",
"bankName": "<string>",
"sortCode": "<string>",
"number": "<string>"
},
"status": "<string>",
"currency": "<string>",
"country": "<string>",
"isPermanent": true,
"expiryTime": 123,
"created": "2023-11-07T05:31:56Z",
"expired": "2023-11-07T05:31:56Z"
}
}{
"message": "Invalid API key",
"status": "failed"
}{
"message": "Access denied: IP address not whitelisted",
"status": "failed"
}{
"message": "Virtual account not found",
"status": "failed"
}Error responses
These are the standard failures forGET /v1/virtual-account/{virtualAccountId}.
| Status | Message | What it means | How to fix |
|---|---|---|---|
| 401 | API key missing or incorrect | Authentication header is missing, invalid, or expired. | Send the right x-api-key for your workspace/environment. |
| 404 | Virtual account ID not found | The ID does not exist or is outside your workspace. | Double-check you are using an ID returned by the creation endpoints. |
| 500 | Service temporarily unavailable | Backend system/dataset failure prevented the lookup. | Retry with backoff and contact support if it persists. |
Authorizations
Path Parameters
The unique identifier of the virtual account.
Was this page helpful?
⌘I

