Kūrėjams

GET/v3/getbalance

Gauti paskyros likutį

Gauti išsaugotą jūsų API paskyros likutį, valiutą ir mokėjimo sąlygas.

Šiame puslapyje
  1. Užklausa
  2. Atsakymas
  3. Klaidos ir naudojimas

Gauti paskyros, kurią atitinka jūsų API prisijungimo duomenys, likutį, valiutą ir mokėjimo sąlygų reikšmę. Tai likučio užklausa; ji nepapildo sąskaitos lėšomis ir nepateikia užsakymo.

Užklausa

Naudokite serverio pusėje saugomus API prisijungimo duomenis ir HTTPS ryšį. Pavyzdžiuose prisijungimo duomenys nuskaitomi iš aplinkos kintamųjų; juose nėra veikiančių prisijungimo duomenų. Patikrinkite status.code JSON turinyje ir HTTP būseną. Šios senosios apdorojimo funkcijos ne visada nustato HTTP klaidos būseną, kai įvyksta programos klaida.

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

Kelio, užklausos eilutės ar užklausos turinio parametrų nereikia.

Atsakymas

Tai pavyzdinė atsakymo struktūra, o ne paskyros duomenys ar dabartinės kainos pasiūlymas.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "125.50",
    "currency": "USD",
    "terms": "prepaid"
  }
}
Likučio užklausos atsakymo laukai
LaukasReikšmė
balanceIšsaugotas paskyros likutis. Apdorodami pinigines reikšmes išlaikykite dešimtainį tikslumą.
currencyŠiai paskyrai išsaugota valiutos reikšmė.
termsIšsaugota paskyros mokėjimo sąlygų reikšmė. Apdorojimo funkcija neišvardija galimų šio lauko reikšmių ir jų nenormalizuoja; nemanykite, kad pavyzdys apima visas galimas reikšmes.

Klaidos ir naudojimas

Nepavykus nustatyti tapatybės, naudojamas bendras API tapatybės nustatymo atsakymas. Ši apdorojimo funkcija neapibrėžia atskiros klaidos, kai nėra likučio duomenų, ir nenumato skaidymo į puslapius. Grąžintas likutis nereiškia, kad lėšos rezervuotos, ir negarantuoja, kad vėlesnis užsakymas bus sėkmingas.