Consulter le solde
curl --request GET \
--url https://sandbox-api.caurisflux.com/api/v1/payments/balance \
--header 'X-API-Key: <api-key>'import requests
url = "https://sandbox-api.caurisflux.com/api/v1/payments/balance"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://sandbox-api.caurisflux.com/api/v1/payments/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://sandbox-api.caurisflux.com/api/v1/payments/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 => [
"X-API-Key: <api-key>"
],
]);
$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://sandbox-api.caurisflux.com/api/v1/payments/balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.caurisflux.com/api/v1/payments/balance")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.caurisflux.com/api/v1/payments/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_bodySolde
Consulter le solde
Récupérer le solde disponible par catégorie
GET
/
payments
/
balance
Consulter le solde
curl --request GET \
--url https://sandbox-api.caurisflux.com/api/v1/payments/balance \
--header 'X-API-Key: <api-key>'import requests
url = "https://sandbox-api.caurisflux.com/api/v1/payments/balance"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://sandbox-api.caurisflux.com/api/v1/payments/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://sandbox-api.caurisflux.com/api/v1/payments/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 => [
"X-API-Key: <api-key>"
],
]);
$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://sandbox-api.caurisflux.com/api/v1/payments/balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.caurisflux.com/api/v1/payments/balance")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.caurisflux.com/api/v1/payments/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_bodyRécupère votre solde disponible et en attente par catégorie.
Authentification
X-API-Key: pk_test_xxx:sk_test_xxx
Requête
curl https://sandbox-api.caurisflux.com/api/v1/payments/balance \
-H "X-API-Key: pk_test_xxx:sk_test_xxx"
Réponse
{
"success": true,
"data": {
"categories": {
"collect": {
"available": 1500000,
"pending": 250000
},
"payout": {
"available": 500000,
"pending": 0
},
"credit": {
"available": 0,
"pending": 0
}
},
"totals": {
"available": 2000000,
"pending": 250000
},
"currency": "XOF",
"updatedAt": "2024-01-15T12:30:00.000Z"
}
}
Catégories de balance
| Catégorie | Description |
|---|---|
collect | Solde des encaissements (paiements reçus) |
payout | Solde dédié aux décaissements |
credit | Ligne de crédit (si activée) |
Champs de réponse
| Champ | Type | Description |
|---|---|---|
categories | object | Soldes par catégorie |
categories.*.available | number | Montant disponible immédiatement |
categories.*.pending | number | Montant en attente de validation |
totals.available | number | Total disponible (toutes catégories) |
totals.pending | number | Total en attente (toutes catégories) |
currency | string | Devise des montants |
updatedAt | string | Date de dernière mise à jour |
Utilisation
Utilisez cet endpoint pour :- Vérifier le solde disponible avant un payout
- Afficher le solde dans votre dashboard
- Déclencher des alertes de solde bas
Solde disponible vs pending
- available : Montant utilisable immédiatement pour les payouts
- pending : Montant en attente (paiements non encore confirmés par le provider)
Les fonds passent de
pending à available après confirmation par le provider de paiement (généralement quelques heures à 24h).⌘I