Get wallet | SchoolSet | Documentation

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

{
  "status": "success",
  "message": "Wallet retrieved successfully.",
  "data": {
    "id": 12345,
    "wallet_type": {
      "id": 2,
      "title": "Student Wallet",
      "description": "Wallet used for student payments and fees",
      "sys_name": "student_wallet",
      "slug": "student-wallet"
    },
    "wallet_data": {
      "balance": 250.75,
      "currency": "USD",
      "last_transaction_date": "2024-06-10T15:45:00Z"
    },
    "wallet_description": "Primary wallet for student transactions",
    "merchant_account_type": {
      "id": 5,
      "name": "Standard Merchant Account",
      "description": "Merchant account supporting ACH and credit card payments",
      "sys_name": "standard_merchant",
      "slug": "standard-merchant",
      "ach_enabled": true,
      "credit_card_enabled": true
    },
    "merchant_account_customer_info": {
      "customer_name": "Greenwood High School",
      "contact_email": "billing@greenwoodhigh.edu"
    },
    "merchant_account_id": "MCA-987654",
    "active": true,
    "wallet_status_id": 3,
    "alerts": {
      "low_balance": false,
      "pending_transactions": 1
    },
    "info": {
      "created_at": "2023-11-01T09:00:00Z",
      "last_updated": "2024-06-10T15:45:00Z"
    },
    "payer_id": 7890,
    "payer_type": "student",
    "priority": "high",
    "removed_on_gateway": false
  }
}

Returns a wallet by its ID with related wallet data.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

Successful GET response for /api/v1/wallet/{id}.

statusstring

messagestring

dataobject