Balance Globale

Pour obtenir le solde marchand de tous les codes pays par devise dans le système NoWallet, utilisez le point de terminaison suivant :

GET{baseUrl}/check/transactions/global/balances/{currency}

note

Le paramètre currency dans l'URL est le code de la devise pour laquelle vous souhaitez vérifier le solde. Par exemple, XAF pour le Franc CFA.

Paramètres de la requête

Lors de la vérification du solde, la requête doit inclure les paramètres suivants dans l'URL :

Name	In	Type	Required	Description
currency	path	string	true	La devise pour laquelle le solde sera vérifié

Exemples de code dans plusieurs langages

Pour vous aider à intégrer l'API NoWallet de manière transparente, nous fournissons des exemples de code dans différents langages de programmation. Ces exemples montrent comment faire une requête vers le point de terminaison 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 fetch pour les environnements de navigateur ou Node.js.
• Ruby : En utilisant la bibliothèque rest-client pour les applications Ruby.
• Python : En utilisant la bibliothèque requests pour les projets Python.
• PHP : En utilisant GuzzleHttp pour les intégrations PHP.
• Java : En utilisant HttpURLConnection pour les applications Java.
• Go : En utilisant le package net/http pour les projets Go.

Exemple de requête

Ci-dessous, un exemple pour vérifier le solde de tous les codes pays par devise en utilisant différents langages. Sélectionnez l'onglet correspondant à votre langage préféré pour voir l'implémentation.

note

Assurez-vous de remplacer {access-token} par votre véritable jeton API et de fournir les paramètres requis pour la requête.

cURL

# Example cURL command to get global balance
curl -X GET {baseUrl}/check/transactions/global/balances/{currency} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

HTTP

GET {baseUrl}/check/transactions/global/balances/{currency} HTTP/1.1

Accept: application/json

JavaScript

const headers = {
  Accept: "application/json",
  Authorization: "Bearer {access-token}",
};

fetch("{baseUrl}/check/transactions/global/balances/{currency}", {
  method: "GET",

  headers: headers,
})
  .then(function (res) {
    return res.json();
  })
  .then(function (body) {
    console.log(body);
  });

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '{baseUrl}/check/transactions/global/balances/{currency}',
  params: {
  }, headers: headers

p JSON.parse(result)

Python

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('{baseUrl}/check/transactions/global/balances/{currency}', headers = headers)

print(r.json())

PHP

<?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/global/balances/{currency}', 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());
}

// ...

Java

URL obj = new URL("{baseUrl}/check/transactions/global/balances/{currency}");
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());

Go

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/global/balances/{currency}", 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 solde pour tous les codes pays par devise. La structure de la réponse dépendra de l'implémentation spécifique.

Status	Signification	Description	Schéma
200	OK	Informations sur le solde global récupérées avec succès pour la devise	ResponseGlobalBalanceDto
400	Bad Request	Erreurs possibles liées à une mauvaise requête	Aucun

Types de réponse

La réponse sera au format JSON.

Réponse de succès (200 OK)

Exemple de réponse réussie avec les informations de solde.

{
  "bglobal": {
    "balance": 200,
    "deposit": 140,
    "withdrawal": 60,
    "potentialBalance": 100,
    "possibleWithdrawal": 100,
    "update": "2025-01-01TZ00:00:00"
  },
  "bcountry": [
    {
      "balance": 200,
      "deposit": 150,
      "withdrawal": 60,
      "potentialBalance": 100,
      "possibleWithdrawal": 100,
      "update": "2025-01-01TZ00:00:00"
    }
  ]
}

Réponse d'erreur (400 Bad Request)

Erreurs possibles pour une mauvaise requête

{
  "statusCode": 400,
  "error": "CURRENCY_NOT_FOUND",
  "message": "It seems that this currency does not exist or You can't perform this action, this token does not allow you"
}

Cette page vous a-t-elle été utile ?