Skip to main content
Multi-use virtual accounts can accept multiple incoming payments. Use them when you need a persistent collection account for a customer or use case.

Endpoint

POST /clients/business/virtual-accounts

Headers

Authorization
string
required
Bearer YOUR_ACCESS_TOKEN
SECRET_KEY
string
required
Your API secret key.
businessId
string
required
Your business ID.

Request body

firstName
string
required
First name to assign to the virtual account holder.
lastName
string
required
Last name to assign to the virtual account holder.
type
string
required
Account duration type. Accepted values: "temporal" or "permanent".
reference
string
required
A unique reference string you generate to identify this account in your system. Must be unique per account.

Response

Returns 201 Created on success.
status
boolean
true on success.
message
string
Confirmation message, e.g. "Account generated successfully".
data.accountNumber
string
The NUBAN account number generated for this virtual account.
data.accountName
string
The name on the account, derived from the firstName and lastName provided.
data.clientRef
string
The reference you supplied, echoed back for confirmation.
data.systemRef
string
A unique reference generated by Interstellas for this account.

Example response

{
  "status": true,
  "message": "Account generated successfully",
  "data": {
    "accountNumber": "9000081483",
    "accountName": "Tola Wuyi",
    "clientRef": "Bu90037366fcMn",
    "systemRef": "STL|jYcphJZcT73yjv"
  }
}

Code examples

curl -X POST https://sandbox.stellasbank.com/api/v1/clients/business/virtual-accounts \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "SECRET_KEY: YOUR_SECRET_KEY" \
  -H "businessId: YOUR_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Ada",
    "lastName": "Lovelace",
    "type": "permanent",
    "reference": "ref_unique_001"
  }'