Dezvoltatori

GET/v3/getbalance

Consultarea soldului contului

Consultați soldul, moneda și condițiile de plată stocate pentru contul dumneavoastră API.

Pe această pagină
  1. Cerere
  2. Răspuns
  3. Erori și utilizare

Consultați soldul, moneda și valoarea condițiilor de plată ale contului identificat prin datele dumneavoastră de autentificare API. Această operațiune consultă soldul; nu adaugă fonduri și nu plasează o comandă.

Cerere

Utilizați datele de autentificare API pe partea de server, prin HTTPS. Exemplele citesc datele de autentificare din variabile de mediu; ele nu conțin date de autentificare funcționale. Verificați status.code în corpul JSON, precum și starea HTTP. Aceste rutine de procesare mai vechi nu setează în mod consecvent o stare de eroare HTTP atunci când apare o eroare a aplicației.

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

Nu sunt necesari parametri în cale, în șirul de interogare sau în corpul cererii.

Răspuns

Aceasta este o structură de răspuns oferită ca exemplu, nu date ale unui cont sau o ofertă de preț actuală.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "125.50",
    "currency": "USD",
    "terms": "prepaid"
  }
}
Câmpurile răspunsului privind soldul
CâmpSemnificație
balanceSoldul stocat al contului. Păstrați precizia zecimală atunci când prelucrați valori monetare.
currencyValoarea monedei stocată pentru acest cont.
termsValoarea condițiilor de plată stocată pentru cont. Rutina de procesare nu enumeră valorile posibile și nu normalizează această valoare; nu presupuneți că exemplul acoperă toate valorile posibile.

Erori și utilizare

În cazul eșecului autentificării, se utilizează răspunsul comun de autentificare al API-ului. Această rutină de procesare nu definește o eroare separată pentru lipsa soldului și nici paginare. Soldul returnat nu reprezintă o rezervare de fonduri și nu garantează că o comandă ulterioară va reuși.