List wallets
curl --request GET \
--url https://api.cartevo.co/api/v1/wallets \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cartevo.co/api/v1/wallets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cartevo.co/api/v1/wallets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cartevo.co/api/v1/wallets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.cartevo.co/api/v1/wallets"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.cartevo.co/api/v1/wallets")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cartevo.co/api/v1/wallets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Data retrieved successfully",
"data": [
{
"id": "422541f3-80e2-41e0-b7a2-24017586b374",
"balance": "0.24",
"payin_balance": "306",
"payout_balance": "1646",
"payin_amount": "982.6",
"payout_amount": "1994",
"amount_to_recover": "0",
"is_active": true,
"currency": "XAF",
"country": "Cameroon",
"country_iso_code": "CM",
"company_id": "eca5e982-00b5-4aa2-b709-7d5cd673e95c",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"country_phone_code": "237",
"phoneNumbers": [
{
"id": "32e525ac-a4a3-47fa-896e-4ef89f64d2d0",
"wallet_id": "422541f3-80e2-41e0-b7a2-24017586b374",
"country_iso_code": "CM",
"country_phone_code": "+237",
"currency": "XAF",
"phone_number": "650695112",
"operator": "MTN",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"operators": [
{
"id": "f079c4db-4897-4ae7-9371-87950ad2429c",
"country_iso_code": "CM",
"country_phone_code": "237",
"currency": "XAF",
"operator_code": "mtn",
"operator_name": "MTN Money",
"otp_required": false,
"ussd_code": "*126#",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}
]
}Wallets
List Wallets
Retrieve every wallet provisioned for your company, with current balances broken down into pay-in and pay-out sub-balances.
GET
/
wallets
List wallets
curl --request GET \
--url https://api.cartevo.co/api/v1/wallets \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cartevo.co/api/v1/wallets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cartevo.co/api/v1/wallets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cartevo.co/api/v1/wallets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.cartevo.co/api/v1/wallets"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.cartevo.co/api/v1/wallets")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cartevo.co/api/v1/wallets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Data retrieved successfully",
"data": [
{
"id": "422541f3-80e2-41e0-b7a2-24017586b374",
"balance": "0.24",
"payin_balance": "306",
"payout_balance": "1646",
"payin_amount": "982.6",
"payout_amount": "1994",
"amount_to_recover": "0",
"is_active": true,
"currency": "XAF",
"country": "Cameroon",
"country_iso_code": "CM",
"company_id": "eca5e982-00b5-4aa2-b709-7d5cd673e95c",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"country_phone_code": "237",
"phoneNumbers": [
{
"id": "32e525ac-a4a3-47fa-896e-4ef89f64d2d0",
"wallet_id": "422541f3-80e2-41e0-b7a2-24017586b374",
"country_iso_code": "CM",
"country_phone_code": "+237",
"currency": "XAF",
"phone_number": "650695112",
"operator": "MTN",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"operators": [
{
"id": "f079c4db-4897-4ae7-9371-87950ad2429c",
"country_iso_code": "CM",
"country_phone_code": "237",
"currency": "XAF",
"operator_code": "mtn",
"operator_name": "MTN Money",
"otp_required": false,
"ussd_code": "*126#",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}
]
}Overview
GET /wallets returns every wallet provisioned under your company. Each entry includes the current payin_balance and payout_balance, plus configured phone numbers and operators.
For a slimmer balances-only view, see GET /payment/balance.
When to use it
- Render a wallets overview in your dashboard.
- Look up a wallet’s
idfor use in other endpoints. - Inspect configured operators per wallet.
Prerequisites
- Authenticated as a company user.
Request
Headers
| Name | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <access_token> |
Response
200 — Success
{
"success": true,
"statusCode": 200,
"message": "Data retrieved successfully",
"data": [
{
"id": "w1a2b3c4-d5e6-7890-abcd-ef1234567890",
"company_id": "c1a2b3c4-d5e6-7890-abcd-ef1234567890",
"currency": "XAF",
"country": "Cameroon",
"country_iso_code": "CM",
"country_phone_code": "+237",
"balance": 175000,
"payin_balance": 125000,
"payout_balance": 50000,
"payin_amount": 200000,
"payout_amount": 75000,
"amount_to_recover": 0,
"is_active": true,
"created_at": "2026-04-01T08:00:00.000Z",
"updated_at": "2026-05-09T10:15:00.000Z",
"phoneNumbers": [
{ "id": "...", "phone_number": "237670000000", "operator": "mtn", "is_default": true }
],
"operators": [
{ "operator_code": "mtn", "payin_active": true, "payout_active": true },
{ "operator_code": "orange", "payin_active": true, "payout_active": false }
]
}
]
}
Field reference
| Field | Type | Description |
|---|---|---|
id | string | Wallet ID (UUID). |
currency | string | ISO 4217. |
country_iso_code | string | ISO 3166-1 alpha-2. |
payin_balance | number | Funds collected from end users, currently in this wallet. |
payout_balance | number | Funds available to disburse via POST /payment/payout. |
balance | number | Total balance (typically payin_balance + payout_balance). |
payin_amount | number | Lifetime pay-in volume. |
payout_amount | number | Lifetime pay-out volume. |
amount_to_recover | number | Outstanding debt against this wallet (see Glossary → Debt). |
is_active | boolean | false when an admin has disabled the wallet. |
phoneNumbers | array | Mobile-money phone numbers configured against this wallet. |
operators | array | Operators enabled for pay-in / pay-out on this wallet. |
Error responses
| Status | Trigger |
|---|---|
401 | Missing or expired Bearer token. |
Code examples
cURL
curl https://api.cartevo.co/api/v1/wallets \
-H "Authorization: Bearer $TOKEN"
Node.js (axios)
const { data } = await axios.get("https://api.cartevo.co/api/v1/wallets", {
headers: { Authorization: `Bearer ${token}` },
});
const usdWallet = data.data.find((w) => w.currency === "USD");
Related
GET /wallets/{id}— single wallet detail.GET /payment/balance— slim balances view.POST /wallets— create a new wallet.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
⌘I