WAPI – Guthabenkonto

Dieser Artikel enthält Informationen zu den folgenden Anfragen:

• account-list – Liste der Bewegungen auf dem Guthabenkonto
• credit-info – Informationen zum aktuellen Guthabenstand

---

account-list

Verwenden Sie account-list Anfrage zum Abrufen einer Liste der Bewegungen auf Ihrem Guthabenkonto im gewählten Zeitraum.

Parameter

• date_from – Anfangsdatum der aufgeführten Bewegungen im Format YYYY-MM-DD
• date_to – Enddatum der aufgeführten Bewegungen im Format YYYY-MM-DD

Rückgabewerte

• 1000 – OK
• 3004 – ungültige Eingabe – fehlendes Von- und Bis-Datum
• 3005 – ungültige Eingabe – ungültige Daten

Antwortdaten

Die Anfrage liefert die folgenden Informationen zurück:

• ID – Kennung der Bewegung
• type – Typ (Zahlung oder Einzahlung)
• num – Bestellnummer
• description
• amount
• bill_num – Rechnungsnummer
• bill_date – Rechnungsdatum
• blockiert – blockiertes Guthaben
• created_date – Datum und Uhrzeit der Anfrage

Vorlagen

JSON-Anfrage:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "account-list",
    "clTRID": "your ID",
    "data": {
      "date_from": "YYYY-MM-DD",
      "date_to": "YYYY-MM-DD"
    }
  }
}

JSON-Antwort (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "account-list",
    "data": {
      "XXXX": {
        "ID": "XXXX (account movement ID)",
        "type": "payment or deposit",
        "num": "order number",
        "description": "description",
        "amount": "amount",
        "bill_num": "",
        "bill_date": "",
        "blocked": 0,
        "created_date": "date and time of request"
      }
    }
  }
}

---

credit-info

Verwenden Sie credit-info Anfrage zum Abrufen des aktuellen Guthabenstands auf Ihrem Guthabenkonto.

Parameter

Diese Anfrage nimmt keine Parameter entgegen.

Rückgabewerte

• 1000 – OK

Antwortdaten

• amount – Stand des Guthabenkontos
• currency – Währung des Guthabenkontos

Vorlagen

JSON-Anfrage:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "credit-info",
    "clTRID": "your ID",
  }
}

JSON-Antwort (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "credit-info",
    "data": {
      "amount": "account balance",
      "currency": "currency code"
    }
  }
}