WorkplaceXchange®The Workplace Balances API consolidates balances for participant retirement plans, reimbursement plans, stock plans, and health savings accounts.
Benefits and Features
The Workplace Balances API provides balance information for our most popular workplace services. It includes a wide range of account-balance details, including vested balances, plan balances, and total spend amounts.
How it works
Third-party applications can use non-delegated access to provide balance inquiry operations for retirement accounts, stock plans, and reimbursement accounts. They can also use delegated access to provide balance inquiries for other types of plans, such as health savings accounts.
Sample use cases
These use cases convey account balance inquiries within a third-party application, such as a plan sponsor mobile app.
Stock plans
Participants can review balances for multiple plan types, including restricted stock units (RSUs), performance awards (PAs), and other plans that make up their total stock plan balance.
The plan balance comprises the sum of contribution balances in employee stock purchase plan (ESPP) balances. For all other plans, the plan balance is the sum of the outstanding value and any cash dividends value.
The vested value is calculated based on the vested quantity, depending on the type of plan.
Retirement accounts
The total asset value provides a high-level overview of all retirement accounts, including Roth IRA balances.
Reimbursement accounts
Plan sponsors can share the balance and election amount for flexible spending accounts, including commuter travel, adoption, and surrogacy.
Historical “Amount spent YTD” data for FSA accounts can be calculated by subtracting “Election amount” from “Product year balance.”
Health savings accounts
Participants can access "Cash available to withdraw" balance data to help manage their health savings expenses.
