WAPI - Kreditní účet

Tento článek obsahuje informace o následujících žádostech:

• account-list - seznam kreditních pohybů na účtu
• credit-info - informace o aktuálním kreditním zůstatku

---

account-list

Pomocí požadavku na seznam účtů získáte seznam pohybů na svém úvěrovém účtu ve zvoleném období.

Parametry

• date_from - počáteční datum uvedených pohybů ve formátu RRRR-MM-DD
• date_to - konečné datum uvedených pohybů ve formátu RRRR-MM-DD

Návratové hodnoty

• 1000 - OK
• 3004 - neplatný vstup - chybí data od a do
• 3005 - neplatný vstup - neplatná data

Údaje o odezvě

Požadavek vrátí následující informace:

• ID - identifikátor pohybu
• type - typ (platba nebo záloha)
• num - číslo objednávky
• popis
• částka
• bill_num - číslo faktury
• bill_date - datum faktury
• blokovaný - blokovaný úvěr
• created_date - datum a čas požadavku

Šablony

Požadavek JSON:

{
  "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"
    }
  }
}

Odpověď JSON (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

Pomocí žádosti o informace o úvěru zjistíte aktuální zůstatek na svém úvěrovém účtu.

Parametry

Tento požadavek nepřebírá žádné parametry.

Návratové hodnoty

• 1000 - OK

Údaje o odezvě

• částka - kreditní zůstatek účtu
• měna - měna kreditního účtu

Šablony

Požadavek JSON:

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

Odpověď JSON (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"
    }
  }
}