Get Family Wallets | SchoolSet

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

{
  "status": "success",
  "message": "Wallets retrieved successfully.",
  "data": [
    {
      "id": 1024,
      "wallet_type": {
        "id": 3,
        "name": "student_allowance",
        "title": "Student Allowance Wallet"
      },
      "wallet_data": {
        "balance": 150.75,
        "currency": "USD",
        "last_transaction_date": "2024-06-10T15:45:00Z"
      },
      "wallet_description": "Monthly allowance wallet for school expenses.",
      "merchant_account_type": {
        "id": 2,
        "title": "Prepaid Account"
      },
      "merchant_account_customer_info": {
        "customer_name": "John Doe",
        "customer_email": "john.doe@example.com"
      },
      "merchant_account_id": 56789,
      "active": true,
      "wallet_status_id": 1,
      "alerts": {
        "low_balance": false,
        "suspicious_activity": false
      },
      "info": {
        "created_at": "2023-09-01T08:30:00Z",
        "last_updated": "2024-06-10T15:45:00Z"
      },
      "payer_id": 2048,
      "payer_type": "parent",
      "priority": 1,
      "removed_on_gateway": false
    }
  ]
}

Returns wallet information for the selected context.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

JSON response payload for family wallets.

statusenum

Allowed values:

messagestring

datalist of objects