Ontwikkelaars

GET/v3/getbalance

Lees rekeningsaldo

Lees die gestoorde saldo, geldeenheid en betalingsvoorwaardes vir jou API-rekening.

Op hierdie bladsy
  1. Versoek
  2. Antwoord
  3. Foute en gebruik

Lees die saldo, geldeenheid en waarde vir betalingsvoorwaardes van die rekening wat deur jou API-aanmeldbesonderhede verteenwoordig word. Dit is 'n saldo-opsoeking; dit voeg nie fondse by of plaas 'n bestelling nie.

Versoek

Gebruik API-aanmeldbesonderhede aan die bedienerkant oor HTTPS. Die voorbeelde lees aanmeldbesonderhede uit omgewingsveranderlikes; hulle bevat geen werkende aanmeldbesonderhede nie. Gaan status.code in die JSON-liggaam sowel as die HTTP-status na. Hierdie verouderde hanteerders stel nie konsekwent 'n HTTP-foutstatus vir 'n toepassingsfout nie.

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

Geen pad-, navraag- of liggaamsparameters word vereis nie.

Antwoord

Dit is 'n voorbeeld van die antwoordstruktuur, nie rekeningdata of 'n huidige pryskwotasie nie.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "125.50",
    "currency": "USD",
    "terms": "prepaid"
  }
}
Vel­de in die saldo-antwoord
VeldBetekenis
balanceDie gestoorde rekeningsaldo. Behou desimale presisie wanneer jy geldwaardes verwerk.
currencyDie geldeenheidwaarde wat vir hierdie rekening gestoor is.
termsDie rekening se gestoorde waarde vir betalingsvoorwaardes. Die hanteerder lys nie die moontlike waardes of normaliseer die waarde nie; moenie aanvaar dat die voorbeeld al die moontlike waardes dek nie.

Foute en gebruik

By 'n stawingsmislukking word die gedeelde API-stawingsantwoord gebruik. Hierdie hanteerder definieer geen afsonderlike fout vir 'n ontbrekende saldo of paginering nie. 'n Saldo wat teruggestuur word, is nie 'n reservering van fondse nie en waarborg nie dat 'n latere bestelling sal slaag nie.