Kehittäjät

GET/v3/getbalance

Hae tilin saldo

Hae API-tilillesi tallennettu saldo, valuutta ja maksuehdot.

Tällä sivulla
  1. Pyyntö
  2. Vastaus
  3. Virheet ja käyttö

Hae API-tunnuksiasi vastaavan tilin saldo, valuutta ja maksuehtojen arvo. Tämä on saldokysely; se ei lisää varoja eikä tee tilausta.

Pyyntö

Käytä palvelinpuolen API-tunnuksia HTTPS-yhteyden kautta. Esimerkit lukevat tunnukset ympäristömuuttujista; ne eivät sisällä toimivia tunnuksia. Tarkista JSON-rungon status.code sekä HTTP-tila. Nämä vanhat käsittelijät eivät johdonmukaisesti aseta HTTP-virhetilaa sovellusvirheen yhteydessä.

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

Polku-, kysely- tai runkoparametreja ei tarvita.

Vastaus

Tämä on havainnollistava esimerkki vastauksen rakenteesta, ei tilitietoja eikä ajantasainen hintatarjous.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "125.50",
    "currency": "USD",
    "terms": "prepaid"
  }
}
Saldovastauksen kentät
KenttäMerkitys
balanceTallennettu tilin saldo. Säilytä desimaalitarkkuus rahamääriä käsitellessäsi.
currencyTälle tilille tallennettu valuutan arvo.
termsTilille tallennettu maksuehtojen arvo. Käsittelijä ei luettele mahdollisia arvoja eikä normalisoi arvoa; älä oleta, että esimerkki kattaa kaikki mahdolliset arvot.

Virheet ja käyttö

Todennuksen epäonnistuessa käytetään API:n yhteistä todennusvastausta. Tämä käsittelijä ei määrittele erillistä virhettä puuttuvalle saldolle eikä sivutusta. Palautettu saldo ei ole varojen varaus eikä takaa myöhemmän tilauksen onnistumista.