Administrative APIs | REST

A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

Unique identifier for the employee.

Provide one of the following: card number, Employee Social Security Number, or Employee ID. All are not required. If either or both of the employee identifier fields (SSN or ID) are provided in addition to the card number, the card number is used.

Required if this field is being used as the unique employee identifier and card number is not provided. Either this field, CardNumber or EmployeeID may be used for this purpose.

Required if this field is being used as the unique employee identifier and card number is not provided. Either this field, CardNumber, or Employee SocialSecurity Number may be used for this purpose.

A unique identifier for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.

Unique identifier for the employer, generated when the employer was first set up. First 3 characters are the employers prefix, unique for each employer. Next 9 characters are created by the administrator for the employer.

Optional, (ALL, Current, Previous, and Future). Used to restrict results.

Plan ID, used to restrict results.

A unique identifier for the employee's account, generated by WCA when the account was first set up.

Optional, if set to true, the method may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.

False (0) or True (1) values accepted. Note: For security, the Card Proxy number is always returned in the response.

Returns the coverage continuation type for the account, if applicable. If participant is active, or coverage continuation is not enabled, then a blank value is returned.

Returns the subgroup ID for the participant account, if applicable

Returns the account segment ID for the participant account, if applicable

Returns the admin/user/function who created the account. WCA system Admin username

Returns the subgroup name for the participant account, if applicable

Returns the prefunded amount of the account.

The deductible status for the grace period. 0 - No deductible 1 - Deductible not met 2 - Deductible met 4 - No deductible limited Note: Flagging the deductible as met during the prior year’s grace period also updates the deductible met status for the current year.

Must be populated when grace period deductible status is ‘2’ (deductible met) Date entered must be within the plan grace period dates Note: Flagging the deductible as met during the prior year’s grace period also updates the deductible met status for the current year.

Deductible met date for the account.

The current status of the participants account.

Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)

Available Balance = Disbursable Balance + Pre-Auth Hold Balance.

Card Proxy Number. Note: The Card Proxy number is returned in this field when either 0 or 1 is passed in the "CardProxy" field in the request. For security, the Card Proxy number is always returned in the response.

The disbursed amount paid to date for the account.

Year to date total amount of employee deposits by the employee.

Employee Election Amount

Employee Social Security Number

Unique identifier for the employee.

Employer Election Amount

First 3 characters are the employers prefix, unique for each employer. Next 9 characters are created by the ADMINISTRATOR for the employer.

Year to date total amount of employee deposits by the employer.

Unique identifier of the plan that differentiates it from other plans created by the administrator.

Plan End Date the end date of the plan.

Plan Start Date the start date of the plan.

Total amount of all pre-auth transactions that currently do not have a matching force post for this employee

Displays whether the account is Prefunded or Payroll based. True = Prefunded Plan Type False = Payroll Plan Type

Auto Deposit Start Date

A unique identifier for your administrator instance, generated by WCA when the instance was first set up.

Indicates whether or not the employee is opted in for manual claim processing. 0 = Opt Out 1= Opt In Note: This field will only populate if the account type is a Product Partner HSA account type.

The Partner ID that identifies which Product Partner is associated with the account.

Product Partner code

Product Partner Account Number

If the signature card has been received, an account for an HSA plan can be opened. 0 = Not Received/ Account not open. 1 = Received/Account open. Note: This field will only populate if the account type is a Product Partner HSA account type.

Specifies whether data was successfully copied from WealthCare Admin to the Product Partner system. 3 = Success 4 = Error re Validation; see Product Partner Error Code field. 5 = Unexpected Error 6 = Deactivated Note: This field will only populate if the account type is a Product Partner has account type.

Employee Limit

Family Disbursed Paid to date

Family Available balance

Family Preauth balance

(YYYYMMDD) Date the E-Signature was received by the Administrator.

Valid for HSA accounts only. Returns the e-signature code. True or False

This field returns the aggregated total of Ineligible Card transactions by plan and year.

Disbursable Balance = Available Balance minus Auth Hold Balance. If this account has multiple QLE Coverage Periods, this field will contain the current coverage period’s balance. Note : For full-featured HRAs—HRX, HX1 …HX6—with family and individual amounts, this amount is the individual balance for the employee or dependent.

Disbursable Balance = Available Balance minus Auth Hold Balance. If this account has multiple QLE Coverage Periods, this field will contain the current coverage period’s balance.

Coverage Tier designator (Ex.: Single, Family, etc.) for the employee account.ID of coverage tier to which this employee account is associated.

Amount of claims submitted YTD that were applied toward the deductible on this employee account (not paid out).

Deductible amount.

This amount is the maximum balance that an account may be increased to with a Fund Rollover Deposit. If the Fund Rollover deposit would otherwise bring the balance above this amount, then the amount of the Fund Rollover Deposit will be reduced. For example, a participant’s balance is $600 in this account and the Fund Rollover Balance Max is set to $1000. If the source fund has $750 of eligible funds to roll into this account, the rollover amount will be limited to $400 rather than rolling the full $750 so that the balance in the participant's account to which funds are being rolled is $1000. Note: The Target Plan Balance Max only applies to fund rollover deposits.

This amount indicates the maximum balance that is allowed for the Individual Amount within the participant's account after funds have been rolled from another account into this account. The Fund Rollover amount will be limited such that the Individual amount balance after funds have rolled into this account does not exceed the Fund Rollover Individual Balance Max specified. Only set for individual amount in an Individual/Family HRA account.

Deposits made Year to Date INTO this account via Fund Rollover. For an Individual/Family HRA plan, this is the Individual Fund information- If a Dependent ID is provided, then this is the Dependent’s individual Fund information.

Individual/Family HRA plans only. Deposits made Year to Date INTO this account via Fund Rollover.

Determines current status of the process. For an Individual/Family HRA plan, this is the Individual Fund Rollover Status – If a Dependent ID is provided, then this is the Dependent’s individual Fund Rollover Status. 0 = No Status 1 = Not Completed 2 = In Process 4 = Completed 8 = Partial 16 = Account Created 32 = Primary Transaction Calculated 64 = Primary Transaction Pending 128 = Primary Completed 256 = Secondary Transaction Calculated (future) 512 = Secondary Transaction Pending (future) 1024 = Secondary Completed (future)

Determines current status of process. Applies only for Full Feature HRA (HRX plans) family rollover status. 0 = No Status 1 = Not Completed 2 = In Process 4 = Completed 8 = Partial 16 = Account Created 32 = Primary Transaction Calculated 64 = Primary Transaction Pending 128 = Primary Completed 256 = Secondary Transaction Calculated (future) 512 = Secondary Transaction Pending (future) 1024 = Secondary Completed (future)

If the FundRolloverStatusCode = 1 (Not Completed), then a value will exist in this field indicating the specific error.For an Individual/Family HRA plan, this is the Individual Fund Rollover Error Code – If a Dependent ID is provided, then this is the Dependent’s individual Fund Rollover Error Code.

If the FundRolloverStatusCode = 1 (Not Completed), then a value will exist in this field indicating the specific error.For an Individual/Family HRA plan, this is the Individual Fund Rollover Error Code – If a Dependent ID is provided, then this is the Dependent’s individual Fund Rollover Error Code.

YYYYMMDD. Date upon which the employee is eligible to elect benefits.

YYYYMMDD. Date upon which the employee’s account is no longer eligible for benefits. Date must be after employee Account Effective date.

ID of calendar used with Auto Deposit cycle attached to the plan.

Date to begin fixed employer funding for the employee account. Only used if Fixed Employer Funding enabled for the plan and the funding is periodic (rather than upon account creation).

plan is setup to allow claims cross over auto pay, this field specifies the default opt in value when assigning employees to benefit accounts. 0 = Opt Out (Default) 1 = Opt In Note: If not specified, then the employee will be assigned the plan default setting for Claims Crossover Opt-In

0 = No Deductible 1 = Deductible Not Met (Default) 2 = Deductible Met Note: “No Deductible” can be used in conjunction with the WCA Deductible Manager feature. Use this to indicate the employee’s deductible shouldn’t be tracked by WCA. This will wipe out any deductible accumulations calculated by the participant and cannot be undone. Note 2: If using Deductible Manager, then only values of “0” or “1” can be specified. “1” would indicate to continue to allow WCA to track the deductible, while “0” would remove deductible accumulation.

A unique identifier for the employee's account, generated by WCA when the account was first set up.

Returns HSA account status Active = 0, Inactive = 1, Pending = 2, Dormant = 3, ClosedAccount = 4, FrozenPostNoTran = 5, FrozenPostNoDebits = 6, FrozenPostNoChecks = 7, RejectedNeedInfo = 8, RejectedNoUpdates = 9

Amount of interest accrued in current year

Interest rate for HSA

Use this field to indicate the auto pay provider reimbursement setting on the employee account If not specified, and enrolling the participant into a plan using Auto Provider Pay, the employee will automatically inherit the default setting specified on the Benefit Plan. 0 = Pay Me (Default) 1 = Pay Provider

Balance at the start of the processing day (the balance after end of day processing is complete for the prior day). This value only applies to HSA accounts.

Indicates the last day the participant can submit claims for the account.

Indicates if the plan should be hidden from the participant portal.

The product partner product ID sets the service charge model and other attributes of the account. The product partner product ID provided must be a valid product ID as configured for the admin relationship ID assigned to the employee plan.

Returns false if plan is not linked

Returns plan ID of linked plan

Returns Account Type for linked plan

Returns start date of linked plan

Returns end date of linked plan

Suspends debit card activity when there are ineligible/pending transactions 0 = False (Do not suspend debit card activity)

Plan level setting to enable account dormancy. False - not enabled (default) True – enabled