Developer Portal

 Home Getting Started Integration Options Overview Create Cart Collect Payment Reconciliation FAQs Overview Send Fees Collect Payment Overview Create Invoice Update Invoice AutoPay Subscriptions Invoice by Email Invoice by Template Collect Payment Pay Express Payment Testing Certify Your Integration Overview Retrieve Payments Reconciliation District SSO PowerSchool
MySchoolBucks
v26.9.13
ric_p_SAPP03
US

Developer Portal

Contact Us

Have a question or need help? We’re here to support you!

For technical questions, integration support, feedback or feature requests, please contact us at  hss-partnersupport@e-hps.com

 Sign In

Developer Sign In
Sign in with MSB user

Retrieve Payments

GET /payments Endpoint

The following endpoint should be used to pull all payments for a specified client district. This endpoint supports several filters, pagination controls, and is optimized for high-volume retrievals.

GET https://www.myschoolbucks.com/api/latest/{clientId}/payments

Pagination

  • rowCount: Default is 1000. This value can be increased as needed by integrating partners.

  • page: Defaults to 1; used for paginated navigation.

Common Filters and Query Parameters

Several query parameters are available to filter MySchoolBucks payment data. For best performance, ensure all payment requests include parameters.

Parameter Description
Transaction Dates createdDateStart: Start of transaction date range in ISO 8601 format
(e.g., 2025-06-30T03:37:33Z)
createdDateEnd: End of transaction date rangeIf no parameters are defined, a default range of 14 days is applied by default
Batch Dates batchDateStart: Start of deposit date range in ISO 8601 format
(e.g., 2025-06-30T03:37:33Z)
batchDateEnd: End of deposit date rangeAvoid using sample API calls without specifying both batchDateStart and batchDateEnd.
Batch ID batchId: Filter payments by specific deposit batch ID.Multiple batchIds may be included per batch date and are typically unique to each payment gateway. Each Batch ID is unique per gateway and represents a deposit group. For example, credit card payments will have a different batchId than eCheck payments. Use GET /payments/batchSummary to retrieve Batch IDs.
Payment Status paymentStatus: Represents the status of a payment transaction such as preauthorized, pending, authorized, canceled, timeout, or failed.
paymentStatusFilter: A query filter used to exclude failed or canceled transactions. Use authorized as a filter value to retrieve successful records only.
Extend Model extendModel=true: By setting this to true, the API response will include general ledger accounting codes for reconciliation and reporting.
Payment Type paymentType: Filter by payment types such as SALE, CREDIT, REFUND, REVERSAL, PREAUTH, POSTAUTH, or WAIVER.This parameter supports comma separated values
Provider ID / Store ID Optional filters to narrow results by specific provider or store.