Skip to main content

​
Endpoint

GET /clients/business/virtual-account

​
Headers

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

​
Query parameters

​
page
integer
Page number. Defaults to 1.
​
limit
integer
Records per page. Defaults to 10.
See Pagination for full usage.

​
Response

​
status
boolean
true on success.
​
message
string
Human-readable outcome.
​
data
array
Array of transaction objects.
​
data[].recipientAccountNumber
string
The virtual account number that received the payment.
​
data[].transactionId
string
Unique identifier for the transaction.
​
data[].amount
string
Amount received, in kobo.
​
data[].transactionCharge
string
Fee charged for the transaction, in kobo.
​
data[].totalAmount
string
Total amount including charges, in kobo.
​
data[].payerAccountNumber
string
The account number that sent the payment.
​
data[].reason
string
Narration or reason provided by the payer.
​
data[].date
string
ISO 8601 timestamp of the transaction.
​
data[].refundStatus
string
Indicates whether the transaction has been refunded.
​
pagination
object
Standard pagination envelope. See Pagination.

​
Code examples

curl -X GET "https://sandbox.stellasbank.com/api/v1/clients/business/virtual-account?page=1&limit=10" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "SECRET_KEY: YOUR_SECRET_KEY" \
  -H "businessId: YOUR_BUSINESS_ID"

​
Example response

{
  "status": true,
  "message": "Transactions retrieved successfully",
  "data": [
    {
      "recipientAccountNumber": "9012345678",
      "transactionId": "txn_abc001",
      "amount": "500000",
      "transactionCharge": "10000",
      "totalAmount": "510000",
      "payerAccountNumber": "0123456789",
      "reason": "Payment for order_12345",
      "date": "2024-06-09T14:22:00.000Z",
      "refundStatus": "none"
    }
  ],
  "pagination": {
    "totalCount": 42,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextPage": 2,
    "previousPage": 0,
    "limit": 10,
    "lastPage": 5
  }
}
All amounts are in kobo. Divide by 100 to convert to naira.