Ontwikkelaars

GET/v3/getbalance

Accountsaldo opvragen

Vraag het opgeslagen saldo, de valuta en de betalingsvoorwaarden van uw API-account op.

Op deze pagina
  1. Verzoek
  2. Antwoord
  3. Fouten en gebruik

Vraag het saldo, de valuta en de waarde voor de betalingsvoorwaarden op van het account dat bij uw API-inloggegevens hoort. Hiermee vraagt u alleen het saldo op; er wordt geen geld toegevoegd en geen bestelling geplaatst.

Verzoek

Gebruik API-inloggegevens aan de serverzijde via HTTPS. De voorbeelden lezen inloggegevens uit omgevingsvariabelen; ze bevatten geen werkende inloggegevens. Controleer status.code in de JSON-body en controleer ook de HTTP-status. Deze oudere handlers stellen bij een toepassingsfout niet consequent een HTTP-foutstatus in.

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/getbalance"

Er zijn geen pad-, query- of bodyparameters vereist.

Antwoord

Dit is een voorbeeld van de structuur van een antwoord, geen accountgegevens of actuele prijsopgave.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "125.50",
    "currency": "USD",
    "terms": "prepaid"
  }
}
Velden in het saldoantwoord
VeldBetekenis
balanceHet opgeslagen accountsaldo. Behoud de decimale precisie bij het verwerken van geldbedragen.
currencyDe valutawaarde die voor dit account is opgeslagen.
termsDe opgeslagen waarde voor de betalingsvoorwaarden van het account. De handler somt de mogelijke waarden niet op en normaliseert deze waarde niet; ga er niet van uit dat het voorbeeld alle mogelijke waarden omvat.

Fouten en gebruik

Bij een mislukte authenticatie wordt het gemeenschappelijke API-authenticatieantwoord gebruikt. Deze handler definieert geen afzonderlijke fout voor een ontbrekend saldo en geen paginering. Een geretourneerd saldo houdt geen reservering van geld in en garandeert niet dat een latere bestelling zal slagen.