Virtual Accounts

Get Virtual Account Details

GEThttps://backendapi.sayswitchgroup.com/api/v1/dedicated_account/:account_id

This endpoint allows you to retrieve the details of a specific virtual bank account using its unique identifier.

Path Parameter:

account_id - The unique ID of the virtual account you want to retrieve (e.g., 484 in the example)

Sample Request

cURL

curl -X GET https://backendapi.sayswitchgroup.com/api/v1/dedicated_account/484 
  -H "Authorization: Bearer YOUR_SECRET_KEY"

Sample Response

JSON

{
  "success": true,
  "message": "Dedicated account successfully retrieved",
  "data": {
    "id": 484,
    "account_name": "John Doe",
    "account_number": "1581273727",
    "bank_name": "SaySwitch",
    "currency": "NGN",
    "status": "active",
    "blockreason": null,
    "domain": "test",
    "reference": "jqo2p61yeqrlqsv",
    "payment_type_id": 2,
    "routing_code": null,
    "created_at": "2025-05-15T06:26:01.000000Z",
    "updated_at": "2025-05-15T06:26:01.000000Z",
    "customer": {
      "id": 334,
      "first_name": "John",
      "last_name": "Doe",
      "email": "Johndoe@email.com",
      "phone": "08159994269",
      "bvn": null,
      "domain": "test",
      "customer_code": "CUS_ngfz27uqjin3ny5",
      "metadata": "{}",
      "status": "active"
    }
  }
}

Explanation of the Response

Field	Type	Description
id	integer	The unique identifier of this virtual account.
account_name	string	The name associated with this virtual account, usually the customer’s name.
account_number	string	The virtual bank account number (NUBAN).
bank_name	string	The name of the bank providing the virtual account service (e.g., “SaySwitch”).
currency	string	The currency of the virtual account (e.g., “NGN”).
status	string	The current status of the virtual account (e.g., “active”).
blockreason	string	The reason for the account being blocked, if applicable (null if active).
domain	string	The environment or domain this account belongs to (e.g., “test”).
reference	string	A unique reference code generated for this virtual account.
payment_type_id	integer	An internal identifier for the payment type associated with this account.
routing_code	string	A bank-specific routing code (may be null).
created_at	string	The timestamp indicating when this virtual account was created (ISO 8601 format).
updated_at	string	The timestamp indicating when this virtual account was last updated (ISO 8601 format).
customer	object	An object containing information about the customer associated with this virtual account:
id	integer	The unique ID of the customer.
first_name`	string	The customer’s first name.
last_name	string	The customer’s last name.
email	string	The customer’s email address.
phone	string	The customer’s phone number.
bvn	string	The customer’s Bank Verification Number (may be null).
domain	string	The environment or domain the customer belongs to.
customer_code	string	The unique customer code.
metadata	string	Additional information about the customer (often an empty JSON string {}).
status	string	The current status of the customer account (e.g., “active”).