WAPI - Compte de crédit

Cet article fournit des informations sur les demandes suivantes :

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

---

liste de comptes

Utilisez la requête account-list pour obtenir une liste des mouvements sur votre compte de crédit au cours de la période sélectionnée.

Paramètres

• date_from - date initiale des mouvements répertoriés au format AAAA-MM-JJ
• date_to - date finale des mouvements répertoriés au format AAAA-MM-JJ

Valeurs de retour

• 1000 - OK
• 3004 - entrée non valide - dates de début et de fin manquantes
• 3005 - entrée non valide - données non valides

Données de réponse

La demande renvoie les informations suivantes :

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

Modèles

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

---

crédit-info

Utilisez la demande d'informations sur le crédit pour connaître le solde actuel de votre compte de crédit.

Paramètres

Cette demande ne prend aucun paramètre.

Valeurs de retour

• 1000 - OK

Données de réponse

• montant - solde créditeur du compte
• devise - devise du compte de crédit

Modèles

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