Get Payment Balance
curl --request GET \
--url https://api.cartevo.co/api/v1/payment/balance \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cartevo.co/api/v1/payment/balance"
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/payment/balance', 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/payment/balance",
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/payment/balance"
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/payment/balance")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cartevo.co/api/v1/payment/balance")
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,
"message": "Balance retrieved successfully",
"data": {
"balances": [
{
"currency": "XAF",
"country": "CM",
"payin_balance": 50000,
"payout_balance": 30000
}
],
"updated_at": "2025-01-08T12:00:00.000Z"
}
}Payment Collection
Get Payment Balances
Retrieve current pay-in and pay-out balances across every wallet your company holds, broken down by currency and country.
GET
/
payment
/
balance
Get Payment Balance
curl --request GET \
--url https://api.cartevo.co/api/v1/payment/balance \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cartevo.co/api/v1/payment/balance"
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/payment/balance', 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/payment/balance",
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/payment/balance"
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/payment/balance")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cartevo.co/api/v1/payment/balance")
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,
"message": "Balance retrieved successfully",
"data": {
"balances": [
{
"currency": "XAF",
"country": "CM",
"payin_balance": 50000,
"payout_balance": 30000
}
],
"updated_at": "2025-01-08T12:00:00.000Z"
}
}Overview
GET /payment/balance returns the current pay-in and pay-out sub-balances for every wallet your company holds, with one entry per (currency, country) pair. Use this before initiating a payout to verify funds are available, or to render a balances widget in your dashboard.
When to use it
- Pre-flight check before
POST /payment/payoutto avoid400 Insufficient balance. - Render a wallet/balance summary on a dashboard.
- Reconcile your local accounting balance against Cartevo.
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": {
"balances": [
{
"currency": "XAF",
"country": "CM",
"payin_balance": 125000,
"payout_balance": 50000
},
{
"currency": "XOF",
"country": "CI",
"payin_balance": 0,
"payout_balance": 30000
},
{
"currency": "USD",
"country": "US",
"payin_balance": 0,
"payout_balance": 4250.5
}
],
"updated_at": "2026-05-09T10:15:00.000Z"
}
}
| Field | Type | Description |
|---|---|---|
data.balances[] | array | One entry per wallet you own. Empty array if you have no wallets yet. |
data.balances[].currency | string | ISO 4217 (e.g. XAF, XOF, USD). |
data.balances[].country | string | ISO 3166-1 alpha-2 (e.g. CM, CI, US). |
data.balances[].payin_balance | number | Pay-in sub-balance — funds collected from end users, not yet moved. |
data.balances[].payout_balance | number | Pay-out sub-balance — funds available to disburse via POST /payment/payout. |
data.updated_at | string | ISO 8601. The instant Cartevo computed this snapshot. Real-time within ~1 second of any wallet-affecting transaction. |
About the two sub-balances: Each wallet maintains a separate pay-in and pay-out sub-balance. Use POST /wallets/{id}/transfer-internal (currently undocumented; reach out to support) to move funds between them when needed. The USD wallet is also the source-of-funds for card issuance and funding.
Error responses
| Status | Trigger |
|---|---|
401 | Missing or expired Bearer token. |
Code examples
cURL
curl https://api.cartevo.co/api/v1/payment/balance \
-H "Authorization: Bearer $TOKEN"
Node.js (axios)
const { data } = await axios.get(
"https://api.cartevo.co/api/v1/payment/balance",
{ headers: { Authorization: `Bearer ${token}` } }
);
const xafCM = data.data.balances.find(
(b) => b.currency === "XAF" && b.country === "CM"
);
if (xafCM && xafCM.payout_balance < 50000) {
throw new Error("Top up XAF/CM payout wallet before disbursing");
}
Related
POST /payment/payout— uses thepayout_balanceshown here.POST /payment/collect— credits thepayin_balance.- Glossary → Wallet — pay-in vs pay-out sub-balance explanation.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.