WAPI – Zálohový účet

  WAPI (API rozhraní)

Pokud jste WAPI ještě nepoužívali, projděte si nejprve článek WAPI v kostce (manuál).

V tomto článku najdete informace k následujícím příkazům:

account-list

Příkazem account-list získáte výpis pohybů na zálohovém účtu ve zvoleném období.

Parametry
  • date_from – počáteční datum vypisovaných pohybů ve formátu YYYY-MM-DD
  • date_to – koncové datum vypisovaných pohybů ve formátu YYYY-MM-DD
  • 1000 – v pořádku
  • 3004 – chybná vstupní data – neuvedá data od a do
  • 3005 – chybná vstupní data – chybná data

Příkaz vrací výpis položek zálohového účtu:

  • ID – identifikátor pohybu na účtu
  • type – typ platba (payment), nebo vklad (deposit)
  • num – číslo objednávky
  • description – popis
  • amount – částka
  • bill_num – číslo dokladu
  • bill_date – datum dokladu
  • blocked – blokovaná částka na účtu
  • created_date – datum a čas vytvoření požadavku

Šablony

account-list JSON

JSON příkaz: 

{
  "request": {
    "user": "váš@login.tld",
    "auth": "vygenerovaný autorizační řetězec",
    "command": "account-list",
    "clTRID": "vlastní id kód",
    "data": {
      "date_from": "YYYY-MM-DD",
      "date_to": "YYYY-MM-DD"
    }
  }
}
JSON odpověď (OK): 
{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF čas",
    "clTRID": "vlastní id kód",
    "svTRID": "id kód serveru",
    "command": "account-list",
    "data": {
      "XXXX": {
        "ID": "XXXX (ID pohybu na účtu)",
        "type": "typ pohybu",
        "num": "číslo objednávky",
        "description": "popis",
        "amount": "částka",
        "bill_num": "",
        "bill_date": "",
        "blocked": 0,
        "created_date": "datum a čas vytvoření požadavku"
      }
    }
  }
}

account-list XML

XML dotaz: 

<request>
  <user>váš@login.tld</user>
  <auth>vygenerovaný autorizační řetězec</auth>
  <command>account-list</command>
  <clTRID>vlastní id kód</clTRID>
  <data>
    <date_from>YYYY-MM-DD</date_from>
    <date_to>YYYY-MM-DD</date_to>
  </data>
</request>
XML odpověď: 
<response>
  <code>1000</code>
  <result>OK</result>
  <timestamp>UTF čas</timestamp>
  <clTRID>vlastní id kód</clTRID>
  <svTRID>id kód serveru</svTRID>
  <command>account-list</command>
  <data>
    <XXXX>
      <ID>XXXX (ID pohybu na účtu)</ID>
      <type>typ pohybu</type>
      <num>číslo objednávky</num>
      <description>popis</description>
      <amount>částka</amount>
      <bill_num></bill_num>
      <bill_date></bill_date>
      <blocked>0</blocked>
      <created_date>datum a čas vytvoření požadavku</created_date>
    </XXXX>
  </data>
</response>

credit-info

Příkazem credit-info zjistíte aktuální výši kreditu na zálohovém účtu.

Parametry

Tento příkaz nepřijímá žádné parametry.

  • 1000 – stav kreditu úspěšně získán
  • amount – částka na zálohovém účtu
  • currency – měna zálohového účtu

Šablony

credit-info JSON

JSON příkaz: 

{
  "request": {
    "user": "váš@login.tld",
    "auth": "vygenerovaný autorizační řetězec",
    "command": "credit-info",
    "clTRID": "vlastní id kód"
  }
}
JSON odpověď (OK): 
{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF čas",
    "clTRID": "vlastní id kód",
    "svTRID": "id kód serveru",
    "command": "credit-info",
    "data": {
      "amount": "částka",
      "currency": "kód měny"
    }
  }
}

credit-info XML

XML dotaz: 

<request>
  <user>váš@login.tld</user>
  <auth>vygenerovaný autorizační řetězec</auth>
  <command>credit-info</command>
  <clTRID>vlastní id kód</clTRID>
</request>
XML odpověď: 
<response>
  <code>1000</code>
  <result>OK</result>
  <timestamp>UTF čas</timestamp>
  <clTRID>vlastní id kód</clTRID>
  <svTRID>id kód serveru</svTRID>
  <command>credit-info</command>
  <data>
    <amount>částka</amount>
    <currency>kód měny</currency>
  </data>
</response>

Pomohl Vám návod?
Děkujeme za zpětnou vazbu!