List Family Wallets | SchoolSet

curl https://app.schoolset.io/app/api/v1/family/self/wallets \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "status": "success",
  "message": "Wallet records retrieved successfully.",
  "data": [
    {
      "id": 1024,
      "wallet_type": {
        "id": 3,
        "name": "student_lunch",
        "title": "Student Lunch Wallet"
      },
      "wallet_data": {
        "balance": 45.75,
        "currency": "USD",
        "last_transaction_date": "2024-06-10T12:45:00Z"
      },
      "wallet_description": "Prepaid lunch account for student meals.",
      "merchant_account_type": {
        "id": 2,
        "title": "Cafeteria Account"
      },
      "merchant_account_customer_info": {
        "customer_name": "Greenwood High School Cafeteria",
        "contact_email": "cafeteria@greenwoodhs.edu"
      },
      "merchant_account_id": 5678,
      "active": true,
      "wallet_status_id": 1,
      "alerts": {
        "low_balance": true,
        "last_alert_date": "2024-06-09T08:00:00Z"
      },
      "info": {
        "created_by": "admin_user_23",
        "created_at": "2023-08-15T09:30:00Z"
      },
      "payer_id": 7890,
      "payer_type": "parent",
      "priority": 1,
      "removed_on_gateway": false
    }
  ]
}

Lists wallet records for the active school context.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Response

JSON response payload for authenticated family wallets.

statusenum

Allowed values:

messagestring

datalist of objects