Utviklere

GET/v3/getbalance

Hent kontosaldo

Hent lagret saldo, valuta og betalingsvilkår for API-kontoen din.

På denne siden
  1. Forespørsel
  2. Svar
  3. Feil og bruk

Hent saldoen, valutaen og verdien for betalingsvilkår for kontoen som API-legitimasjonen din tilhører. Dette er et saldooppslag; det setter ikke inn penger eller legger inn en bestilling.

Forespørsel

Bruk API-legitimasjon på serversiden over HTTPS. Eksemplene leser legitimasjon fra miljøvariabler; de inneholder ingen fungerende legitimasjon. Kontroller status.code i JSON-innholdet i tillegg til HTTP-statusen. Disse eldre forespørselsbehandlerne angir ikke alltid en HTTP-feilstatus ved en applikasjonsfeil.

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

Ingen parametere i stien, spørringsstrengen eller forespørselsinnholdet er påkrevd.

Svar

Dette er et eksempel på svarstrukturen, ikke kontodata eller et gjeldende pristilbud.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "125.50",
    "currency": "USD",
    "terms": "prepaid"
  }
}
Felter i saldosvaret
FeltBetydning
balanceDen lagrede kontosaldoen. Bevar desimalpresisjonen når du behandler pengebeløp.
currencyValutaverdien som er lagret for denne kontoen.
termsKontoens lagrede verdi for betalingsvilkår. Forespørselsbehandleren verken lister opp de mulige verdiene eller normaliserer verdien; ikke anta at eksemplet dekker alle mulige verdier.

Feil og bruk

Ved autentiseringsfeil brukes API-ets felles autentiseringssvar. Denne forespørselsbehandleren definerer ingen egen feil for manglende saldo og ingen paginering. En returnert saldo innebærer ingen reservasjon av midler og garanterer ikke at en senere bestilling vil lykkes.