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.

A unique identifer for the employee's account, generated by WCA when the account was first set up. This is referred to as a Flex Account Key or Flex Account ID elsewhere in the system.

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

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

(YYYMMDD)Date after which services are eligible for payment.

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

Indicates whether interest is to be accrued for this employee account. If this is set to “0” for an interest bearing account that previously accrued interest, Interest will be paid up to the Interest Close Date provided.

Note: When setting up an existing account as “Yes=1” for interest bearing and the account has transaction history and balances, it is recommended to only activate this feature on the first of the next Interest Payment Cycle. The Transaction History and prior balances will not accrue interest. Interest will only be accrued going forward or for an subsequently back-dated transactions.

The values available are: 0 = No longer bear interest 1 = Bear interest The default of this field if it is not filled in is 0.

Note: This will not be implemented on HSA plan types.

This field is used to define whether or not this account should reaccrue interest for this payment cycle. When an account’s Interest Plan ID or Payment Cycle ID is assigned or updated, this field must be provided. The default is no = 0. A “1” (Reaccrue Interest) means interest should be reaccrued for the accrual period to date using the new Interest Plan. “No” means accrued interest period to date remains as is and is not reaccrued. Note: any subsequent back-dated deposits will accrue interest in accordance with the new interest plan.

The values available are: 0 = Do not reaccrue interest for this payment cycle. 1 = Reaccrue interest for this payment cycle.

The default of this field it is not filled in is 0.

Note**: If “Interest Indicator” is 1 then this field is required.

This field is the interest plan ID. If this is assigned or updated mid-payment cycle, then the interest will be accrued according to the new Interest Plan ID going forward. Any back-dated deposits subsequently received will accrue according to this new Interest Plan.

Note**: If “Interest Bearing Indicator” is 1 then this field is required.

This field must match the an Interest Payment Cycle ID in WCA – otherwise the record will be rejected and no changes made to the Interest Plan settings..

Note**: If “Interest Bearing Indicator” is 1 then this field is required.

YYYYMMDD. This date may only be provided when setting the Interest Bearing Indicator field to “No” for an account previously set to earn interest. Furthermore, if the “Interest Bearing Indicator” value is 0 then this field is required, although it may be left blank. The date provided must be between the Plan’s Start Date and today’s date. If there is no date provided, then the default will be today’s date. If a date prior to today’s date is provided then the interest that has been accrued up until that date will be paid and any interest accrued after that date will not. If the close date is set earlier than a completed interest payment date, please note that the prior interest payments will not be reversed and no further interest will be paid on the account.

Note**: If “Interest Bearing Indicator” is 0 then this field is required

The Account ID for the account to which accrued interest from the source account should be paid. If this field is left blank interest will be paid in accordance with the Employer Plan interest plan setting.

The Plan ID for the account to which accrued interest from the source account should be paid. If this field is left blank interest will be paid in accordance with the Employer Plan interest plan setting.

Note 1: The concatenation of Plan ID, Account Type, Start Date, and End Date must be unique for each plan for this employer. All data must be provided for those fields or all must be left blank.

Note 2: The target account must be a new, active, temporarily inactive or terminated.

The Account Type Code for the account to which accrued interest from the source account should be paid. If this field is left blank interest will be paid in accordance with the Employer Plan interest plan setting.

The Plan Start Date for the account to which accrued interest from the source account should be paid. If this field is left blank interest will be paid in accordance with the Employer Plan interest plan setting.

Note 1: The concatenation of Plan ID, Account Type, Start Date, and End Date represents the employee account. All data must be provided for those fields to update interest target account or all must be left blank to default to Plan or leave as is.

Note 2: The target account must be a new, active, temporarily inactive or terminated.

The Plan End Date for the account to which accrued interest from the source account should be paid. If this field is left blank interest will be paid in accordance with the Employer Plan interest plan setting.

Note 1: The concatenation of Plan ID, Account Type, Start Date, and End Date represents the employee account. All data must be provided for those fields to update interest target account or all must be left blank to default to Plan or leave as is.

Note 2: The target account must be a new, active, temporarily inactive or terminated.