Get Business Virtual Accounts
This endpoint allows you to retrieve all virtual accounts created for your business. The response is paginated, providing 25 accounts per page.
Endpoint
URL: https://api.chapa.co/v1/virtual-accounts
Method: GET
Authentication
Authorization: Pass your secret key as a bearer token in the request headerContent-Type: application/json
Response
A successful request returns a list of virtual accounts with pagination details.
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| status | string | Status of the request (“success” or “failed”) |
| message | string | A message describing the result |
| data | object | Contains pagination details and accounts information |
Pagination Parameters
| Parameter | Type | Description |
|---|---|---|
| current_page | number | The current page number |
| first_page_url | string | URL to the first page of results |
| from | number | Starting index of records on current page |
| next_page_url | string | URL to the next page (null if on last page) |
| path | string | Base path for pagination URLs |
| per_page | number | Number of records per page (default: 25) |
| prev_page_url | string | URL to the previous page (null if on first page) |
| to | number | Ending index of records on current page |
Account Object Properties
| Property | Type | Description |
|---|---|---|
| account_name | string | Name of the account holder |
| account_number | number | Unique virtual account number |
| account_alias | string | Optional alias for the account (null if not set) |
| balance | number | Current balance in the account |
| status | string | Status of the account (e.g., “active”) |
| currency | string | Currency of the account (e.g., “ETB”) |
| created_at | string | Timestamp of account creation |
| updated_at | string | Timestamp of last account update |
Example Request
import requestsurl = "https://api.chapa.co/v1/virtual-accounts"headers = { 'Content-Type': 'application/json', 'Accept': 'application/json', 'Authorization': 'Bearer CHASECK-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'}response = requests.get(url, headers=headers)print(response.text)