List Customer Wallets

GET

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

Retrieves a paginated list of customer wallets for the store, with optional filters for wallet balance and expiring credit.

🔑Scopes

third_customer_wallet_read - Customer Wallet Read

Request

Query Params

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/customers/?page=1&page_size=20&balance_min=100&balance_max=1000&expiring_in_days=30&expiring_before=2026-09-30' \
--header 'Store-Id: 123456' \
--header 'X-manager-Token: {{Access-Token}}'

Response Example

200 - Example 1

{
    "results": [
        {
            "customer_id": 987654,
            "name": "Ahmed Ali",
            "phone_number": "+966501234567",
            "email": "ahmed@example.com",
            "balance": "250.5",
            "total_balance": "300.5",
            "held_balance": 50,
            "currency": "SAR",
            "pending_cashback": "25",
            "soonest_expiry": {
                "date": "2026-09-15",
                "amount": 50
            },
            "cutoff_expiry": {
                "date": "2026-09-30",
                "amount": 125
            }
        }
    ],
    "total": 245,
    "page": 1,
    "page_size": 20
}

Modified at 2026-09-02 10:01:27

Get Wallet Analytics by Rule

Bulk Credit Customer Wallets