Balance par Pays
Pour obtenir la balance du marchand pour un code pays spécifique dans le système NoWallet, utilisez l'endpoint suivant :
{baseUrl}/check/transactions/single/balances/{country}Le paramètre country dans l'URL correspond au code du pays pour lequel vous souhaitez consulter la balance. Par exemple, CM pour le Cameroun.
Paramètres de la Requête
Lors de la vérification de la balance, la requête doit inclure les paramètres suivants dans l’URL :
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| country | path | string | true | Code du pays dont on souhaite vérifier la balance |
Exemples de Code dans Plusieurs Langages
Pour faciliter l'intégration de l’API NoWallet, nous fournissons des exemples de code dans plusieurs langages de programmation. Ces exemples montrent comment effectuer une requête vers l’endpoint de l’API et traiter la réponse.
- Shell (cURL) : Pour des tests rapides et une utilisation en ligne de commande.
- HTTP : Format brut de la requête HTTP pour comprendre la structure.
- JavaScript : En utilisant
fetchpour les environnements de navigateur ou Node.js. - Ruby : En utilisant la bibliothèque
rest-clientpour les applications Ruby. - Python : En utilisant la bibliothèque
requestspour les projets Python. - PHP : En utilisant
GuzzleHttppour les intégrations PHP. - Java : En utilisant
HttpURLConnectionpour les applications Java. - Go : En utilisant le package
net/httppour les projets Go.
Exemple de Requête
Voici un exemple illustrant comment vérifier la balance pour un code pays spécifique dans différents langages. Sélectionnez l’onglet correspondant à votre langage préféré pour voir l’implémentation.
Assurez-vous de remplacer {access-token} par votre jeton API réel et de fournir les paramètres requis dans la requête.
- cURL
- HTTP
- JavaScript
- Ruby
- Python
- PHP
- Java
- Go
# Example cURL command to get single balance
curl -X GET {baseUrl}/check/transactions/single/balances/{country} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET {baseUrl}/check/transactions/single/balances/{country} HTTP/1.1
Accept: application/json
const headers = {
Accept: "application/json",
Authorization: "Bearer {access-token}",
};
fetch("{baseUrl}/check/transactions/single/balances/{country}", {
method: "GET",
headers: headers,
})
.then(function (res) {
return res.json();
})
.then(function (body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '{baseUrl}/check/transactions/single/balances/{country}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('{baseUrl}/check/transactions/single/balances/{country}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','{baseUrl}/check/transactions/single/balances/{country}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("{baseUrl}/check/transactions/single/balances/{country}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "{baseUrl}/check/transactions/single/balances/{country}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Paramètres de la Réponse
La réponse de l’API contiendra les informations de la balance pour le code pays spécifié. La structure de la réponse peut varier selon l’implémentation, mais inclura généralement les champs suivants :
- country: Le code pays pour lequel la balance est consultée.
- deposit: Montant total des dépôts dans la devise spécifiée.
- withdrawal: Montant total des retraits dans la devise spécifiée.
- message: Informations ou messages d’erreur éventuels liés à la requête.
- statusCode: Code de statut indiquant le succès ou l’échec (par exemple, 200 pour succès, 400 pour erreur de requête).
| Status | Signification | Description | Schéma |
|---|---|---|---|
| 200 | OK | Informations de la balance récupérées avec succès | ResponseSingleBalanceDto |
| 400 | Bad Request | Erreur possible dans la requête | Aucun |
Types de Réponses
La réponse sera retournée au format JSON.
Réponse de Succès (200 OK)
Exemple d’une réponse réussie contenant les informations de la balance.
{
"balance": 200,
"deposit": 140,
"withdrawal": 60,
"potentialBalance": 100,
"possibleWithdrawal": 100,
"update": "2025-01-01TZ00:00:00"
}
Réponse d’Erreur (400 Bad Request)
Exemple d’erreur pour un code pays invalide ou non autorisé.
{
"statusCode": 400,
"error": "COUNTRY_CODE_NOT_FOUND",
"message": "It seems that this country code does not exist or You can't perform this action, this token does not allow you"
}
Cette page vous a-t-elle été utile ?