Get Wallet Analytics

Developing

GET

https://api.zid.sa//v1/customer-wallets/analytics/

Retrieves store-level customer wallet metrics, including outstanding wallet balance, cashback rewards, wallet redemptions, and cashback ROI.

Request

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠401Unauthorized

🔴500Internal Server error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.zid.sa//v1/customer-wallets/analytics/' \
--header 'Store-Id: 123456' \
--header 'X-manager-Token: {{Access-Token}}'

Response Example

200 - Example 1

{
    "outstanding_balance": {
        "amount": 12500.5,
        "currency": "SAR"
    },
    "cashback_rewarded": {
        "amount": 3500.75,
        "customer_count": 245,
        "currency": "SAR"
    },
    "wallet_redeemed": {
        "amount": 2100.25,
        "customer_count": 180,
        "currency": "SAR"
    },
    "cashback_roi": {
        "ratio": 4.25,
        "revenue": 14875.5,
        "cashback_rewarded": 3500.75,
        "currency": "SAR"
    }
}

Modified at 2026-09-02 08:47:02

Delete Cashback Rule

Get Wallet Analytics by Rule