WAPI – Compte de crédit

Cet article fournit des informations sur les requêtes suivantes :

• account-list – liste des mouvements du compte de crédit
• credit-info – informations sur le solde de crédit actuel

---

account-list

Utilisez account-list pour obtenir la liste des mouvements de votre compte de crédit sur la période sélectionnée.

Paramètres

• date_from – date de début des mouvements listés au format YYYY-MM-DD
• date_to – date de fin des mouvements listés au format YYYY-MM-DD

Valeurs retournées

• 1000 – OK
• 3004 – saisie non valide – dates de début et de fin manquantes
• 3005 – saisie non valide – données non valides

Données de la réponse

La requête renvoie les informations suivantes :

• ID – identifiant du mouvement
• type – type (paiement ou dépôt)
• num – numéro de commande
• description
• amount
• bill_num – numéro de facture
• bill_date – date de facture
• bloqué – crédit bloqué
• created_date – date et heure de la demande

Modèles

Requête 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"
    }
  }
}

Réponse 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

Utilisez credit-info pour connaître le solde actuel de votre compte de crédit.

Paramètres

Cette requête ne prend aucun paramètre.

Valeurs retournées

• 1000 – OK

Données de la réponse

• amount – solde du compte de crédit
• currency – devise du compte de crédit

Modèles

Requête JSON :

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

Réponse 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"
    }
  }
}