Skip to main content
GET
/
v1
/
virtual-account
/
{VirtualAccountId}
Get Virtual Account Details
const url = 'https://sandboxapi.me-cash.com/v1/virtual-account/{VirtualAccountId}';
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}, body: undefined};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
{
  "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"
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

VirtualAccountId
string<uuid>
required

The unique identifier of the virtual account.

Response

Virtual account details retrieved successfully.

message
string
Example:

"virtual account fetched successfully"

status
string
Example:

"success"

data
object
I