Virtual AccountGet Virtual Accounts

Get Virtual Accounts

This endpoint allows you to retrieve a comprehensive list of all virtual bank accounts associated with your platform. This is useful for oversight, reporting, and managing your payment ecosystem.

API Endpoint

GET https://backendapi.sayswitchgroup.com/api/v1/list_dedicated_accounts

Sample Request

curl -X GET https://backendapi.sayswitchgroup.com/api/v1/list_dedicated_accounts \
  -H "Authorization: Bearer YOUR_SECRET_KEY"
 
### Sample Response
 
```json copy
{
    "success": true,
    "message": "Managed accounts 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"
            }
        },
        {
            "id": 485,
            "account_name": "test tester",
            "account_number": "1654101278",
            "bank_name": "SaySwitch",
            "currency": "NGN",
            "status": "active",
            "blockreason": null,
            "domain": "test",
            "reference": "erdgsilhfo3rzxu",
            "payment_type_id": 2,
            "routing_code": null,
            "created_at": "2025-05-15T07:07:25.000000Z",
            "updated_at": "2025-05-15T07:07:25.000000Z",
            "customer": {
                "id": 335,
                "first_name": "test",
                "last_name": "tester",
                "email": "test@email.com",
                "phone": "08159994269",
                "bvn": null,
                "domain": "test",
                "customer_code": "CUS_im4nqocx55tum1p",
                "metadata": "{}",
                "status": "active"
            }
        }
    ],
    "meta": {
        "total": 2
    }
}

Response Fields

Account Object

FieldTypeDescription
idintegerUnique identifier for the virtual account
account_namestringName associated with the account
account_numberstringVirtual bank account number
bank_namestringBank name (SaySwitch)
currencystringAccount currency
statusstringAccount status (active/inactive)
referencestringUnique reference for the account
created_atstringAccount creation timestamp
updated_atstringLast update timestamp

Customer Object

FieldTypeDescription
customer_codestringUnique customer identifier
first_namestringCustomer’s first name
last_namestringCustomer’s last name
emailstringCustomer’s email address
phonestringCustomer’s phone number
statusstringCustomer account status