Get Family Payments Scheduled | SchoolSet

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

{
  "status": "success",
  "message": "Scheduled payments retrieved successfully.",
  "data": [
    {
      "id": 1024,
      "donor": {
        "name": "John Doe",
        "email": "john.doe@example.com",
        "phone": "+1234567890"
      },
      "payer_id": 5678,
      "payer_type": "parent",
      "can_edit_payer": false,
      "fundraising": {
        "campaign": "Spring Fundraiser 2024",
        "goal_amount": 5000,
        "raised_amount": 3200
      },
      "batch_id": 202304,
      "amount_payment": 250.75,
      "base_amount_payment": 250.75,
      "payment_date": "2024-07-15",
      "currency": "USD",
      "method": "credit_card",
      "type": "tuition",
      "payment_type": "scheduled",
      "payment_type_id": 3,
      "status": "pending",
      "billing_info": {
        "address": "123 Elm Street",
        "city": "Springfield",
        "state": "IL",
        "zip": "62704"
      },
      "check_date": null,
      "payment_source": "online_portal",
      "paid_recurring_payments": [
        {
          "id": 1001,
          "amount": 250.75,
          "date": "2024-06-15"
        }
      ],
      "paid_upcoming_payments": [
        {
          "id": 1002,
          "amount": 250.75,
          "date": "2024-08-15"
        }
      ],
      "paid_recurring_payment": {
        "id": 1001,
        "status": "completed"
      },
      "paid_upcoming_payment": {
        "id": 1002,
        "status": "scheduled"
      },
      "replaces_payment": {},
      "replaced_payments": [],
      "successful_repeated_payment": {},
      "balance_after_collected_payment": 1250.5,
      "contract_fees_sorts_global_split": {},
      "notes": [
        "Payment scheduled for mid-July."
      ],
      "attachments": [],
      "emails": [
        {
          "to": "john.doe@example.com",
          "subject": "Payment Scheduled Confirmation"
        }
      ],
      "sms": [],
      "voice": [],
      "fee_actual": 5.25,
      "fee_fixed": 1,
      "fee_percentage": 2.1,
      "credit_type": {},
      "credit_payment": {},
      "merchant_account_customer_info": {
        "customer_id": "cust_7890",
        "email": "john.doe@example.com"
      },
      "merchant_account_id": 3001,
      "merchant_account_type": {
        "type": "stripe",
        "region": "US"
      },
      "contract_id": 450,
      "replaced_payment_id": null,
      "payment_recurring_id": 789,
      "payment_upcoming_id": 790,
      "parent_repayment_id": null,
      "payment_split_id": null,
      "payment_split": {},
      "contract_fees_type": {},
      "previous_contract": {},
      "wallet": {
        "id": 501,
        "wallet_type": {
          "id": 10,
          "name": "Primary Wallet",
          "title": "Visa Credit Card"
        },
        "wallet_data": {
          "last_four": "4242",
          "expiry": "12/25"
        },
        "wallet_description": "Visa ending in 4242",
        "merchant_account_type": {
          "id": 3001,
          "title": "Stripe"
        },
        "merchant_account_customer_info": {
          "customer_id": "cust_7890"
        },
        "merchant_account_id": 3001,
        "active": true,
        "wallet_status_id": 1,
        "alerts": {},
        "info": {},
        "payer_id": 5678,
        "payer_type": "parent",
        "priority": 1,
        "removed_on_gateway": false
      },
      "cc_not_save": false,
      "secondary_wallet": {
        "id": 502,
        "wallet_type": {
          "id": 11,
          "name": "Backup Wallet",
          "title": "MasterCard Debit"
        },
        "wallet_data": {
          "last_four": "1234",
          "expiry": "11/24"
        },
        "wallet_description": "MasterCard ending in 1234",
        "merchant_account_type": {
          "id": 3002,
          "title": "PayPal"
        },
        "merchant_account_customer_info": {
          "customer_id": "cust_7890"
        },
        "merchant_account_id": 3002,
        "active": true,
        "wallet_status_id": 1,
        "alerts": {},
        "info": {},
        "payer_id": 5678,
        "payer_type": "parent",
        "priority": 2,
        "removed_on_gateway": false
      },
      "grace_period": 5,
      "allocations": [
        {
          "allocation_id": 1,
          "amount": 150.5,
          "description": "Tuition Fee"
        },
        {
          "allocation_id": 2,
          "amount": 100.25,
          "description": "Activity Fee"
        }
      ],
      "allocated_amount": 250.75,
      "unallocated_amount": 0,
      "note": "First installment for Fall semester.",
      "family_student_pay": {
        "student_id": 300,
        "family_id": 1024
      },
      "fee_coverage": 0,
      "payment_settings": {
        "auto_pay": true,
        "reminder_enabled": true
      }
    }
  ]
}

Returns family 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 scheduled family payments.

statusenum

Allowed values:

messagestring

datalist of objects