> ## Documentation Index
> Fetch the complete documentation index at: https://docs.umeme.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Solde

> Rend le solde disponible du portefeuille de votre revendeur.

Portée de la clé : `portefeuille:lire`.



## OpenAPI

````yaml openapi/v1.json GET /v1/portefeuille
openapi: 3.1.0
info:
  title: API Umeme pour les intégrateurs
  version: 1.0.0
  description: >-
    Contrat de l'API Umeme pour les intégrateurs : vendre de l'électricité
    prépayée et des abonnements TV depuis le portefeuille de votre revendeur.
servers:
  - url: https://sandbox.umeme.app
    description: Sandbox d'intégration
  - url: https://api.umeme.app
    description: Production
security:
  - cle: []
tags:
  - name: Ventes
  - name: Compteurs
  - name: Portefeuille
  - name: Outils
paths:
  /v1/portefeuille:
    get:
      tags:
        - Portefeuille
      summary: Solde
      description: |-
        Rend le solde disponible du portefeuille de votre revendeur.

        Portée de la clé : `portefeuille:lire`.
      operationId: lireSolde
      responses:
        '200':
          description: Le solde.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Portefeuille'
              example:
                solde: 995
                devise: USD
                misAJourLe: '2026-11-07T08:26:44Z'
        '401':
          $ref: '#/components/responses/NonAuthentifie'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl "$UMEME_BASE_URL/portefeuille" \
              -H "Authorization: Bearer $UMEME_CLE"
        - lang: javascript
          label: Node.js · fetch
          source: |-
            // Node.js 18 et plus : fetch est intégré.
            const baseUrl = process.env.UMEME_BASE_URL;

            const reponse = await fetch(`${baseUrl}/portefeuille`, {
              headers: {
                Authorization: `Bearer ${process.env.UMEME_CLE}`,
              },
            });
            const donnees = await reponse.json();
        - lang: javascript
          label: Node.js · Axios
          source: |-
            // npm install axios
            import axios from "axios";

            const umeme = axios.create({
              baseURL: process.env.UMEME_BASE_URL,
              headers: { Authorization: `Bearer ${process.env.UMEME_CLE}` },
              timeout: 30000,
            });

            const { data } = await umeme.get("/portefeuille");
        - lang: python
          label: Python
          source: |-
            import os

            import requests

            BASE_URL = os.environ["UMEME_BASE_URL"]
            ENTETES = {"Authorization": f"Bearer {os.environ['UMEME_CLE']}"}

            reponse = requests.get(
                f"{BASE_URL}/portefeuille",
                headers=ENTETES,
                timeout=30,
            )
            donnees = reponse.json()
        - lang: php
          label: PHP
          source: |-
            // composer require guzzlehttp/guzzle
            $client = new GuzzleHttp\Client([
                'base_uri' => getenv('UMEME_BASE_URL') . '/',
                'headers' => ['Authorization' => 'Bearer ' . getenv('UMEME_CLE')],
                'timeout' => 30,
            ]);

            $reponse = $client->get('portefeuille');
            $donnees = json_decode($reponse->getBody(), true);
        - lang: java
          label: Java
          source: >-
            // Java 15 et plus : java.net.http et blocs de texte.

            var baseUrl = System.getenv("UMEME_BASE_URL");

            var client = HttpClient.newHttpClient();


            var requete = HttpRequest.newBuilder(URI.create(baseUrl +
            "/portefeuille"))
                .header("Authorization", "Bearer " + System.getenv("UMEME_CLE"))
                .GET()
                .build();

            var reponse = client.send(requete,
            HttpResponse.BodyHandlers.ofString());
components:
  schemas:
    Portefeuille:
      type: object
      required:
        - solde
        - devise
        - misAJourLe
      properties:
        solde:
          type: number
          description: Le solde disponible, en dollars.
        devise:
          type: string
          enum:
            - USD
          description: Toujours `USD`.
        misAJourLe:
          type: string
          format: date-time
          description: Heure du dernier mouvement, en UTC.
    Erreur:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: 'Stable : il ne se renomme jamais. C''est lui que votre code compare.'
        message:
          type: string
          description: En français, pour vos journaux. Il peut changer.
  responses:
    NonAuthentifie:
      description: >-
        Clé absente, inconnue, révoquée, ou de l'autre environnement :
        `CLE_INVALIDE`, `CLE_REVOQUEE`, `CLE_MAUVAIS_ENVIRONNEMENT`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Erreur'
          example:
            code: CLE_INVALIDE
            message: La clé est absente ou inconnue.
  securitySchemes:
    cle:
      type: http
      scheme: bearer
      description: >-
        Votre clé d'API : `umeme_test_…` dans la sandbox, `umeme_live_…` en
        production.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.