Get family wallets | SchoolSet

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

{
  "status": "success",
  "message": "Retrieved wallets for family ID 12345.",
  "data": [
    {
      "id": 101,
      "wallet_type": {
        "id": 5,
        "title": "Student Lunch Wallet",
        "description": "Wallet used for student cafeteria payments.",
        "sys_name": "student_lunch_wallet",
        "slug": "student-lunch-wallet"
      },
      "wallet_data": {
        "balance": 45.75,
        "currency": "USD",
        "last_transaction_date": "2024-06-10T12:45:00Z"
      },
      "wallet_description": "Primary wallet for school lunch payments.",
      "merchant_account_type": {
        "id": 3,
        "name": "SchoolSet ACH Account",
        "description": "ACH enabled merchant account for school payments.",
        "sys_name": "schoolset_ach",
        "slug": "schoolset-ach",
        "ach_enabled": true,
        "credit_card_enabled": false
      },
      "merchant_account_customer_info": {
        "customer_name": "Greenwood Elementary",
        "customer_id": "CUST-7890"
      },
      "merchant_account_id": "MA-4567",
      "active": true,
      "wallet_status_id": 2,
      "alerts": {
        "low_balance": false,
        "payment_due": true
      },
      "info": {
        "created_by": "admin_user",
        "created_at": "2023-09-01T08:30:00Z"
      },
      "payer_id": 2048,
      "payer_type": "parent",
      "priority": "high",
      "removed_on_gateway": false
    }
  ]
}

Returns all wallets for the specified family.

Authentication

AuthorizationBearer

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

Path parameters

family_idstringRequired

Response

Successful GET response for /api/v1/wallet/family/{family_id}.

statusstring

messagestring

datalist of objects