Administrative APIs | REST

Last Balance Update Received from Product Partner Ex. 1900-01-01T00:00:00

Activity status of the account. 1 = New 2 = Active 3 = Temporarily Inactive 4 = Permanently Inactive 5 = Terminated

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

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

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

Available Balance is the Disbursable Balance plus the 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.

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

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.

If 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

Returns the disbursements paid to date.

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.

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

Unique identifier for the employee.

Employee Social Security Number

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

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

Valid for HSA accounts only. Returns the e-signature date.

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

Amount of interest accrued in current year

Interest rate for HSA

Date of next interest payment

Unique identifier that distinguishes this plan from all others you administer.

(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.

(YYYMMDD)Date that funds are available for services.

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

HSA Account Number

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

Product Partner Application Error Code

ID associated with product partner

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.

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.

Product Partner Signature Card Received - Indicates if account is open

Auto Deposit Start Date

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

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

Product partner name

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.

Year to date interest adjustment

Last Interest Payment Amount

Last Interest Payment Date

Maintenance Fee Model ID

Incident Fee Model ID

Miscellaneous Fee Model ID

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.

Interest Plan ID

Trust Account Model Number

Investment portfolio balance market value

Date of HSA account opening

Date of HSA account closure

Product partner account upload update status

ID Verification Status

ID Verification Failure Reason

Overdraft fees assessed this period

Overdraft fees assessed year to date

Returned item fees assessed this period

Returned item fees assessed year to date

Amount of Uncollected fees

Date next statement will be issued MMDDYYY

Date of death of accountholder MMDDYYY

Total contribution reporting

Total employer contribution reporting

Total HSA contributions made this year

Total contributions made for future year

Total HSA contributions made this year by employer

Total rollover contributions

Fair market value of HSA

HSA Investment Fair Market Value

Fair market value of HSA at date of accountholder death

Normal distribution amount year to date

Total death distribution amount

Death distribution amount to non-spouse

Distribution amount for disability

Distribution of excess contribution

Distribution of excess earnings on contributions

Total prohibited transaction distributions

Total distribution excess contribution earnings

HSA Current Year Processing Contributions

HSA Current Year Processing Contributions Employer

Prior year total contribution reporting

Total prior year reportable contributions made by employer

Prior Year Total Contributions Made During Prior Year

Prior year contributions made during prior year by Employer.

Total previous contributions made for future year

Total prior year rollover contributions

Prior year HSA fair market value

Prior year HSA investment fair market value

Total prior year normal distributions

Total prior year death distributions

Total prior year death distributions to non-spouse

Total prior year disability distributions

Total prior year prohibited transaction distribution

Total prior year distribution of earnings on excess contributions

Total distributions on excess contributions made prior year

Total prior year distribution of excess contributions

HSA Previous Year Processing Contributions

HSA Current Year Processing Contributions Employer

The total initial amount for the year/coverage period. This amount cannot exceed the IRS max contribution for the current tax year. Note: This amount does not affect the HSA cash balance.

HSA Advance used YTD Note: Including an amount in this field results in an error unless it is the first/initial HSA advance period.

HSA Advance recovered YTD Note: Including an amount in this field results in an error unless it is the first/initial HSA advance period.

HSA Advance Outstanding Balance Note: Including an amount in this field results in an error unless it is the first/initial HSA advance period.

HSA Advance Available Balance Note: Including an amount in this field results in an error unless it is the first/initial HSA advance period.

Date when HSA advance is available for spending YYYYMMDD

Used to specify when employee no longer has access to HSA advance amount. WCA automatically sets this date for prior and current period if not submitted. For example, say an HSA Advance period is from 1/1/2020 through 12/31/2020. A file is submitted with: Begin Date is 3/1/2020 End Date is [blank] WCA then updates HSA Advance periods to: 1/1/2020 – 2/29/2020 and 3/1/2020 – 12/31/2020 (Dates in bold are automatically set by WCA) Overlapping HSA Advance periods are not allowed by WCA and result in an error. For example, if a period exists from 1/1 – 4/30, an error is returned if you try to submit a GH record with a begin date of 3/1. The only exception is if overlapping dates are submitted to include the last day of the calendar year ([begin date] – [12/31]). Also, since HSA Advance is tracked within calendar years, the begin and end dates submitted must be within the same calendar year.

HSA Advance Deposit Offset YTD

Total Disbursable Balance

HSA Advance Accessability flag if True then HSA Advance is accessible to the plan.

HSA Advance Non Accessibility Reason