Les différents soldes d'une boutique

Total solde disponible, total solde collecté en espèce et total solde partiellement collecté sur une boutique

L'appel à l'api ci-dessous renvoie les informations d'une boutique et principalement le solde disipoinible, solde partiellement collecté et le solde collecté en cash. Notez que le solde disponible est le montant retirable et que la réponse de l'api dépend essentielement du mode test ou live. Il faut un token d'authentification pour cet appel api.

Solde disipoinible : Solde pouvant etre retiré sur une boutique.

Solde partiellement collecté: Montant total des paiements partiels effectués sur les commandes d'une boutique. Une fois la commande payée en totalité, le montant de la commande est transféré sur le solde retirable de la boutique.

Solde collecté en cash: Solde total collecté en espèces (GOBICASH) par la boutique.

Method: GET

Route :

/api/gobipay/stores/{identifier}/

identifier : il s'agit du slug de la boutique

Response Api

{
  "id": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "slug": "Q4_2YLpql6mYhLmI4vyyY16f-ApZn9pgjW7X-cLUyU5EBM",
  "name": "string",
  "description": "string",
  "logo": "string",
  "store_type": 0,
  "website_url": "string",
  "email_notifications": "user@example.com",
  "currency": "string",
  "status": 1,
  "customer_default_supported_fees": 0,
  "reduction_fees": 0,
  "test_public_key": "string",
  "test_secret_key": "string",
  "live_public_key": "string",
  "live_secret_key": "string",
  "authorized_plateform_and_fees": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "balance": 0,
  "cash_balance": 0,
  "available_balance": 0,
  "partial_collection": 0,
  "last_balance_update_date": "2024-11-28",
  "last_sandbox_balance_update_date": "2024-11-28",
  "nb_days_to_update_available_balance": 0,
  "created_at": "2024-11-28T10:20:29.492Z",
  "updated_at": "2024-11-28T10:20:29.492Z",
  "enterprise": 0
}

Solde collecté, solde collecté en espèce et solde retiré journalièrement ou sur une période

Les informations concernant les paiements et les retraits d'une boutique sont disponibles via l'API. Ces informations peuvent être filtrées selon une période donnée ou non. La route prend des paramètres suivant: actions, mode, start_date, end_date, periode les clés api de la boutique sont requises et en fonction du mode.

Method : GET

Route :

    /api/gobipay/stores/{identifier}/get_store_daily_balance/

identifier : l'identifiant de la boutique.

Les paramètres:

• action: il est obligatoire et peut prendre l'une des valeur suivantes:

  • Payment : Encaissements effectué sur la boutique
  • Withdraw : Retrait / Déboursement sur la boutique
  • Cash: Pour les paiement en espèces de la boutique

• mode: il est obligatoire et peut être:

  • live : lorsque la boutique est en mode live
  • test : lorsque la boutique est en mode sandbox

• periode :C'est la période. Elle n'est pas obligatoire et indique le nombre de jours suivant lequel voud voulez filtrer.

• start_date: date de début du filtre

• end_date : date de fin du filtre

NB: Vous ne pouvez pas renseigner à la fois la période et les dates de début et de fin.

Exemple Appel Api

    /api/gobipay/stores/{identifier}/get_store_daily_balance/?action=Payment&mode=test&periode=2
    /api/gobipay/stores/1/get_store_daily_balance/?action=Withdraw&mode=test
    /api/gobipay/stores/1/get_store_daily_balance/?action=Cash&mode=test
    /api/gobipay/stores/1/get_store_daily_balance/?start_date=2024-08-07&end_date=2024-11-24&action=Payment&mode=test````

Response Api

    {
  "data": {
    "elements": [
      {
        "amount": 87403.0,
        "payment_type": "Wallet",
        "date": "2024-10-11",
        "mode": "test",
        "created_at": "2024-10-11T08:50:31.574225Z",
        "updated_at": "2024-10-11T08:50:31.574401Z"
      },
      {
        "amount": 2124.0,
        "payment_type": "Wallet",
        "date": "2024-10-21",
        "mode": "test",
        "created_at": "2024-10-21T10:26:52.590047Z",
        "updated_at": "2024-10-21T15:54:33.796503Z"
      },
      {
        "amount": 2952.0,
        "payment_type": "Wallet",
        "date": "2024-10-22",
        "mode": "test",
        "created_at": "2024-10-22T09:12:42.722934Z",
        "updated_at": "2024-10-22T09:46:44.876162Z"
      },
      {
        "amount": 225215.0,
        "payment_type": "Wallet",
        "date": "2024-10-25",
        "mode": "test",
        "created_at": "2024-10-25T09:53:04.570820Z",
        "updated_at": "2024-10-25T17:14:03.731381Z"
      },
      {
        "amount": 400000.0,
        "payment_type": "Wallet",
        "date": "2024-10-28",
        "mode": "test",
        "created_at": "2024-10-28T14:28:49.647278Z",
        "updated_at": "2024-10-28T16:39:32.077456Z"
      },
      {
        "amount": 120000.0,
        "payment_type": "Wallet",
        "date": "2024-10-29",
        "mode": "test",
        "created_at": "2024-10-29T09:52:35.794019Z",
        "updated_at": "2024-10-29T09:52:35.794055Z"
      },
      {
        "amount": 1360000.0,
        "payment_type": "Wallet",
        "date": "2024-10-30",
        "mode": "test",
        "created_at": "2024-10-30T10:43:52.153914Z",
        "updated_at": "2024-10-30T12:59:25.971827Z"
      },
      {
        "amount": 78153.4,
        "payment_type": "Wallet",
        "date": "2024-10-31",
        "mode": "test",
        "created_at": "2024-10-31T14:25:38.754531Z",
        "updated_at": "2024-10-31T18:33:51.971739Z"
      }
    ],
    "total": 2275847.4
  },
  "message": "This process is OK",
  "success": true,
  "status": 200
}